Can I use Azure DevOps as a CLI?

Yes. KosmoKrator exposes a Azure DevOps CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Azure DevOps through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Azure DevOps tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Azure DevOps credentials stored?

Azure DevOps credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Azure DevOps MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Azure DevOps Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Azure DevOps KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.azure_devops.*. Use lua_read_doc("integrations.azure-devops") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Azure DevOps workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.azure_devops.get_list_accounts_specific_owner_or_specific_member_one_following_parameters_is_required_ownerid_memberid({owner_id = "example_owner_id", member_id = "example_member_id", properties = "example_properties", api_version = "example_api_version"}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("azure-devops"))' --json
kosmo integrations:lua --eval 'print(docs.read("azure-devops.get_list_accounts_specific_owner_or_specific_member_one_following_parameters_is_required_ownerid_memberid"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local azure_devops = app.integrations.azure_devops
local result = azure_devops.get_list_accounts_specific_owner_or_specific_member_one_following_parameters_is_required_ownerid_memberid({owner_id = "example_owner_id", member_id = "example_member_id", properties = "example_properties", api_version = "example_api_version"})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.azure_devops, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.azure_devops.default.* or app.integrations.azure_devops.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Azure DevOps, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Azure DevOps

Namespace: azure-devops

This integration exposes Azure DevOps Services REST API 7.2 operations generated from the official MicrosoftDocs Swagger specifications. It covers projects, Git repositories and pull requests, work item tracking, builds, releases, pipelines, artifacts and package feeds, test plans/results, service hooks, security, Graph identities, notifications, dashboards, environments, and organization APIs.

Authentication

Provide either an Azure DevOps personal access token (personal_access_token) or a Microsoft Entra access token (access_token). PAT credentials are sent using Basic authentication with an empty username, matching Azure DevOps REST API guidance.

Usage notes

Most tools require organization; many also require project.
API versions default to the version declared by the official 7.2 Swagger operation. Override with api_version only when you know the host supports it.
Query and path parameters use snake_case names. For example, repositoryId becomes repository_id.
Raw upload endpoints use body.content and optional body.content_type.
Different endpoint families target different Azure DevOps hosts, including dev.azure.com, vssps.dev.azure.com, pkgs.dev.azure.com, vsrm.dev.azure.com, and service-specific hosts. The generated tools keep the official host for each operation.

Example

local projects = azure_devops_core_projects_list({ organization = "contoso" })
local repos = azure_devops_git_repositories_list({ organization = "contoso", project = "Website" })
local work_items = azure_devops_wit_work_items_get_work_items_batch({
  organization = "contoso",
  project = "Website",
  body = { ids = { 1, 2, 3 }, fields = { "System.Title", "System.State" } }
})

Raw agent markdown

# Azure DevOps

Namespace: `azure-devops`

This integration exposes Azure DevOps Services REST API 7.2 operations generated from the official MicrosoftDocs Swagger specifications. It covers projects, Git repositories and pull requests, work item tracking, builds, releases, pipelines, artifacts and package feeds, test plans/results, service hooks, security, Graph identities, notifications, dashboards, environments, and organization APIs.

## Authentication

Provide either an Azure DevOps personal access token (`personal_access_token`) or a Microsoft Entra access token (`access_token`). PAT credentials are sent using Basic authentication with an empty username, matching Azure DevOps REST API guidance.

## Usage notes

- Most tools require `organization`; many also require `project`.
- API versions default to the version declared by the official 7.2 Swagger operation. Override with `api_version` only when you know the host supports it.
- Query and path parameters use snake_case names. For example, `repositoryId` becomes `repository_id`.
- Raw upload endpoints use `body.content` and optional `body.content_type`.
- Different endpoint families target different Azure DevOps hosts, including `dev.azure.com`, `vssps.dev.azure.com`, `pkgs.dev.azure.com`, `vsrm.dev.azure.com`, and service-specific hosts. The generated tools keep the official host for each operation.

## Example

```lua
local projects = azure_devops_core_projects_list({ organization = "contoso" })
local repos = azure_devops_git_repositories_list({ organization = "contoso", project = "Website" })
local work_items = azure_devops_wit_work_items_get_work_items_batch({
  organization = "contoso",
  project = "Website",
  body = { ids = { 1, 2, 3 }, fields = { "System.Title", "System.State" } }
})
```

Metadata-derived Lua example

local result = app.integrations.azure_devops.get_list_accounts_specific_owner_or_specific_member_one_following_parameters_is_required_ownerid_memberid({owner_id = "example_owner_id", member_id = "example_member_id", properties = "example_properties", api_version = "example_api_version"})
print(result)

Functions

get_list_accounts_specific_owner_or_specific_member_one_following_parameters_is_required_ownerid_memberid Read

Get a list of accounts for a specific owner or a specific member. One of the following parameters is required: ownerId, memberId. Official Azure DevOps REST API 7.2 endpoint: GET https://app.vssps.visualstudio.com/_apis/accounts (spec: account/7.2/accounts.json).

Lua path: app.integrations.azure_devops.get_list_accounts_specific_owner_or_specific_member_one_following_parameters_is_required_ownerid_memberid
Full name: azure-devops.azure_devops_account_accounts_list

Parameter	Type	Required	Description
`owner_id`	string	no	ID for the owner of the accounts.
`member_id`	string	no	ID for a member of the accounts.
`properties`	string	no	query parameter `properties`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_all_advanced_filters_organization Read

Gets all advanced filters for the organization. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/reporting/filtersSettings/alertsbatch (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.gets_all_advanced_filters_organization
Full name: azure-devops.azure_devops_advanced_security_filters_settings_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`include_deleted`	boolean	no	Whether to include soft-deleted filters.
`keywords`	string	no	Optional filter to search filters by name (case-insensitive, partial match).
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_new_advanced_filter_organization Read

Creates a new advanced filter for the organization. Official Azure DevOps REST API 7.2 endpoint: POST https://advsec.dev.azure.com/{organization}/_apis/reporting/filtersSettings/alertsbatch (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.creates_new_advanced_filter_organization
Full name: azure-devops.azure_devops_advanced_security_filters_settings_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The advanced filter to create.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_specific_advanced_filter_by_its_id Read

Gets a specific advanced filter by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/reporting/filtersSettings/alertsbatch/{filterId} (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.gets_specific_advanced_filter_by_its_id
Full name: azure-devops.azure_devops_advanced_security_filters_settings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`filter_id`	string	yes	The ID of the advanced filter to retrieve.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_advanced_filter_only_name_can_be_updated Read

Updates an advanced filter. Only the name can be updated. Official Azure DevOps REST API 7.2 endpoint: PATCH https://advsec.dev.azure.com/{organization}/_apis/reporting/filtersSettings/alertsbatch/{filterId} (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.updates_advanced_filter_only_name_can_be_updated
Full name: azure-devops.azure_devops_advanced_security_filters_settings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The update data containing the new name.
`filter_id`	string	yes	The ID of the advanced filter to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_advanced_filter Read

Deletes an advanced filter. Official Azure DevOps REST API 7.2 endpoint: DELETE https://advsec.dev.azure.com/{organization}/_apis/reporting/filtersSettings/alertsbatch/{filterId} (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.deletes_advanced_filter
Full name: azure-devops.azure_devops_advanced_security_filters_settings_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`filter_id`	string	yes	The ID of the advanced filter to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_alert_summary_by_severity_org Read

Get Alert summary by severity for the org Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/reporting/summary/alerts (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.get_alert_summary_by_severity_org
Full name: azure-devops.azure_devops_advanced_security_summary_dashboard_get_alert_summary_for_org

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`criteria_alert_types`	array	no	If provided, only return summary data for alerts of this type. Otherwise, return summary data for alerts of all types.
`criteria_keywords`	string	no	If provided, only return repos whose titles match this pattern.
`criteria_period`	string	no	If provided, summary data will be scoped to this time period.
`criteria_projects`	array	no	If provided, only return summary data for these projects Otherwise, return summary data for all projects.
`criteria_severities`	array	no	If provided, only return summary data for alerts at these severities. <br />Otherwise, return summary data for alerts at any severity.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_combined_alerts_org Read

Get Combined Alerts for the org Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/reporting/summary/alertsbatch (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.get_combined_alerts_org
Full name: azure-devops.azure_devops_advanced_security_summary_dashboard_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`criteria_alert_type`	string	no	If provided, only return alerts of the specified alert type.
`criteria_alert_validity_status`	string	no	If provided, only return alerts with the specified validity status.
`criteria_component_names`	array	no	If provided, only return dependency alerts for the specified package names.
`criteria_component_types`	array	no	If provided, only return dependency alerts for the specified ecosystems (e.g., NuGet, Npm, Maven).
`criteria_dismissal_types`	array	no	If provided, only return alerts with one of the specified dismissal types (closure reasons). Applicable only when filtering for closed/dismissed alerts.
`criteria_fixed_date_end`	string	no	If provided, only return alerts fixed on or before this date.
`criteria_fixed_date_start`	string	no	If provided, only return alerts fixed on or after this date.
`criteria_introduced_date_end`	string	no	If provided, only return alerts introduced on or before this date.
`criteria_introduced_date_start`	string	no	If provided, only return alerts introduced on or after this date.
`criteria_keywords`	string	no	If provided, only return alerts whose titles match this pattern.
`criteria_projects`	array	no	If provided, only return alerts for projects whose names are in this list.
`criteria_repositories`	array	no	If provided, only return alerts for repositories whose names are in this list.
`criteria_repository_ids`	array	no	If provided, only return alerts for repositories whose IDs (GitRepositoryId) are in this list.
`criteria_rule_names`	array	no	If provided, only return code scanning alerts or secret alerts matching the specified rule names.
`criteria_secret_types`	array	no	If provided, only return secret alerts matching the specified secret types (rule friendly name or opaque ID).
`criteria_severities`	array	no	If provided, only return alerts with the specified severities. Otherwise, return alerts at any severity.
`criteria_state`	string	no	If provided, return alerts that are active or inactive based on this value. <br />Otherwise, return alerts in any state.
`criteria_tool_names`	array	no	If provided, only return code scanning alerts detected by the specified tools.
`top`	number	no	The maximum number of alerts to return
`continuation_token`	string	no	If there are more alerts than can be returned, a continuation token is placed in the "x-ms-continuationtoken" header. Use that token here to get the next page of alerts
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_enablement_summary_org Read

Get Enablement summary for the org Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/reporting/summary/enablement (spec: advancedSecurity/7.2/advancedSecurity.Reporting.json).

Lua path: app.integrations.azure_devops.get_enablement_summary_org
Full name: azure-devops.azure_devops_advanced_security_summary_dashboard_get_enablement_summary_for_org

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`criteria_keywords`	string	no	If provided, only return repos whose titles match this pattern.
`criteria_projects`	array	no	If provided, only return summary data for these projects. Otherwise, return summary data for all projects.
`criteria_states_any_tool`	boolean	no	True if any tool is enabled for the repository, false if any tool is disabled.
`criteria_states_code_alerts`	boolean	no	True if code scanning alerts are enabled for the repository, false if disabled.
`criteria_states_code_pralerts`	boolean	no	True if code scanning pull request alerts are enabled for the repository, false if disabled.
`criteria_states_dependency_alerts`	boolean	no	True if dependency alerts are enabled for the repository, false if disabled.
`criteria_states_dependency_pralerts`	boolean	no	True if dependency pull request alerts are enabled for the repository, false if disabled.
`criteria_states_push_protection`	boolean	no	True if pushes containing secrets will be blocked, false if they will not.
`criteria_states_secret_alerts`	boolean	no	True if secret scanning is enabled for the repository, false if disabled.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_alerts_by_alert_ids_currently_supports_fetching_secret_alerts_only Read

Get alerts by alert IDs Currently supports fetching secret alerts only. Official Azure DevOps REST API 7.2 endpoint: POST https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/AlertsBatch (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.get_alerts_by_alert_ids_currently_supports_fetching_secret_alerts_only
Full name: azure-devops.azure_devops_advanced_security_alerts_batch_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request containing alert IDs and optional alert type filter
`project`	string	yes	Project ID or project name
`repository`	string	yes	The name or ID of the repository
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_alerts_repository Read

Get alerts for a repository Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.get_alerts_repository
Full name: azure-devops.azure_devops_advanced_security_alerts_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	The name or ID of the repository
`top`	number	no	The maximum number of alerts to return
`order_by`	string	no	Must be "id" "firstSeen" "lastSeen" "fixedOn" or "severity" Defaults to "id"
`criteria_alert_ids`	array	no	If provided, only return alerts with the ids specified. <br />Otherwise, return any alert.
`criteria_alert_type`	string	no	If provided, only return alerts of this type. Otherwise, return alerts of all types.
`criteria_confidence_levels`	array	no	If provided, only return alerts at these confidence levels. <br />Both High and Other need to be specified to fetch alerts of all confidence levels. <br />Otherwise, return alerts with high confidence level. <br />Only applicable for secret alerts.
`criteria_dependency_name`	string	no	If provided, only alerts for this dependency are returned. <br />Otherwise, return alerts for all dependencies. <br />In a sarif submission, a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation. <br />Not applicable for secret alerts.
`criteria_from_date`	string	no	If provided, only return alerts last seen after this date. <br />Otherwise return all alerts.
`criteria_has_linked_work_items`	boolean	no	If provided, filters alerts based on whether they have linked work items. <br />Set to "true" to return only alerts with linked work items. <br />Set to "false" to return only alerts without linked work items. <br />If not provided, returns all alerts regardless of linked work items. <br />Not applicable for secret and dependency scanning alerts.
`criteria_is_triaged`	boolean	no	If provided with isTriaged, only return alerts that have been triaged. <br />Otherwise, return alerts regardless of triage status.
`criteria_keywords`	string	no	If provided, only return alerts whose titles match this pattern.
`criteria_license_name`	string	no	If provided, only alerts created for dependency with this license are returned. <br />Otherwise, return alerts for all licenses. <br />In a sarif submission, license for a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation.properties.license. <br />Not applicable for secret alerts.
`criteria_modified_since`	string	no	If provided, only return alerts that were modified since this date. <br />Otherwise return all alerts.
`criteria_only_default_branch`	boolean	no	If true or not set, only return alerts found on the default branch of the repository. <br />If there have been no runs completed on the default branch, the last run is used instead regardless of the branch used for that run. If false, return alerts from all branches. <br />This option is ignored if ref is provided. <br />Not applicable for secret alerts.
`criteria_phase_id`	string	no	If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases. <br />Not applicable for secret alerts.
`criteria_phase_name`	string	no	If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases. <br />Not applicable for secret alerts.
`criteria_pipeline_id`	number	no	If provided with pipelineId, only return alerts detected in this pipeline <br />Otherwise, return alerts detected in all pipelines.
`criteria_pipeline_name`	string	no	If provided, only return alerts detected in this pipeline. <br />Otherwise, return alerts detected in all pipelines. <br />Not applicable for secret alerts.
`criteria_ref`	string	no	If provided, only include alerts for this ref. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is no analysis configuration for the default branch. <br />Otherwise, include alerts from all branches. <br />Not applicable for secret alerts.
`criteria_rule_id`	string	no	If provided, only return alerts for this rule. <br />Otherwise, return alerts of all rules.
`criteria_rule_name`	string	no	If provided, only return alerts for this rule. <br />Otherwise, return alerts for all rules.
`criteria_severities`	array	no	If provided, only return alerts at these severities. <br />Otherwise, return alerts at any severity.
`criteria_states`	array	no	If provided, only return alerts in these states. <br />Otherwise, return alerts in any state.
`criteria_to_date`	string	no	If provided, only return alerts last seen before this date. <br />Otherwise return all alerts.
`criteria_tool_name`	string	no	If provided with toolName, only return alerts detected by this tool. <br />Otherwise, return alerts detected by all tools.
`criteria_validity`	array	no	If provided, only return alerts with the validity specified here. If the validity status is Unknown, fetch alerts of all validity results. <br />Only applicable for secret alerts. <br />Filtering by validity status may cause less alerts to be returned than requested with TOP parameter. <br />Due to this behavior, the ContinuationToken(<![CDATA[<header name>]]>) in the response header should be relied on to decide if another batch needs to be fetched.
`expand`	string	no	query parameter `expand`.
`continuation_token`	string	no	If there are more alerts than can be returned, a continuation token is placed in the "x-ms-continuationtoken" header. Use that token here to get the next page of alerts
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_alerts_metadata Read

Get alerts metadata. Official Azure DevOps REST API 7.2 endpoint: POST https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/metadatabatch (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.get_alerts_metadata
Full name: azure-devops.azure_devops_advanced_security_metadata_batch_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`repository`	string	yes	Name or id of a repository that alert is part of
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_alert Read

Get an alert. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId} (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.get_alert
Full name: azure-devops.azure_devops_advanced_security_alerts_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`alert_id`	number	yes	ID of alert to retrieve
`repository`	string	yes	Name or id of a repository that alert is part of
`ref`	string	no	query parameter `ref`.
`expand`	string	no	Expand attributes of a secret alert. Possible values are `None` and `ValidationFingerprint`. Defaults to `None`. Be aware that if `expand` is set to `ValidationFingerprint`, the response may contain the secret in its unencrypted form. Please exercise caution when using this data.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_status_alert Read

Update the status of an alert Official Azure DevOps REST API 7.2 endpoint: PATCH https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId} (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.update_status_alert
Full name: azure-devops.azure_devops_advanced_security_alerts_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new status of the alert
`project`	string	yes	Project ID or project name
`alert_id`	number	yes	The ID of the alert
`repository`	string	yes	The name or ID of the repository
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_instances_alert_branch_specified_with_ref_if_ref_is_not_provided_return_instances_alert_default_branch_if_alert_exist_default_branch_or_latest_affected_branch

Read

Get instances of an alert on a branch specified with @ref. If @ref is not provided, return instances of an alert on default branch(if the alert exist in default branch) or latest affected branch. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}/instances (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.get_instances_alert_branch_specified_with_ref_if_ref_is_not_provided_return_instances_alert_default_branch_if_alert_exist_default_branch_or_latest_affected_branch
Full name: azure-devops.azure_devops_advanced_security_instances_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`alert_id`	number	yes	ID of alert to retrieve
`repository`	string	yes	Name or id of a repository that alert is part of
`ref`	string	no	query parameter `ref`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_alert_metadata Read

Get an alert metadata. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}/metadata (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.get_alert_metadata
Full name: azure-devops.azure_devops_advanced_security_metadata2_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`alert_id`	number	yes	ID of alert to retrieve
`repository`	string	yes	Name or id of a repository that alert is part of
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_branches_which_analysis_results_were_submitted Read

Returns the branches for which analysis results were submitted. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/filters/branches (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.returns_branches_which_analysis_results_were_submitted
Full name: azure-devops.azure_devops_advanced_security_analysis_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	path parameter `repository`.
`alert_type`	string	no	The type of alert: Dependency Scanning (1), Secret (2), Code QL (3), etc.
`continuation_token`	string	no	A string variable that represents the branch name and is used to fetch branches that follow it in alphabetical order.
`branch_name_contains`	string	no	A string variable used to fetch branches that contain this string anywhere in the branch name, case insensitive.
`top`	number	no	An int variable used to return the top k branches that satisfy the search criteria.
`include_pull_request_branches`	boolean	no	A bool variable indicating whether or not to include pull request branches.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

soft_deletes_analysis_data_all_pipelines_repository_cleaning_up_associated_advanced_security_alerts Read

Soft-deletes analysis data for all pipelines in a repository, cleaning up the associated Advanced Security alerts. Official Azure DevOps REST API 7.2 endpoint: DELETE https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/pipelineAnalyses (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.soft_deletes_analysis_data_all_pipelines_repository_cleaning_up_associated_advanced_security_alerts
Full name: azure-devops.azure_devops_advanced_security_pipeline_analyses_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	The name or ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

soft_deletes_analysis_data_specific_pipeline_cleaning_up_associated_advanced_security_alerts Read

Soft-deletes analysis data for a specific pipeline, cleaning up the associated Advanced Security alerts. Official Azure DevOps REST API 7.2 endpoint: DELETE https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/pipelineAnalysis/{adoPipelineId} (spec: advancedSecurity/7.2/alert.json).

Lua path: app.integrations.azure_devops.soft_deletes_analysis_data_specific_pipeline_cleaning_up_associated_advanced_security_alerts
Full name: azure-devops.azure_devops_advanced_security_pipeline_analysis_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	The name or ID of the repository.
`ado_pipeline_id`	number	yes	The ID of the ADO pipeline whose analysis data should be cleaned up.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_current_status_advanced_security_organization Read

Get the current status of Advanced Security for the organization Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/management/enablement (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.get_current_status_advanced_security_organization
Full name: azure-devops.azure_devops_advanced_security_org_enablement_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`include_all_properties`	boolean	no	When true, also determine if pushes are blocked if they contain secrets
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_status_advanced_security_organization Read

Update the status of Advanced Security for the organization Official Azure DevOps REST API 7.2 endpoint: PATCH https://advsec.dev.azure.com/{organization}/_apis/management/enablement (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.update_status_advanced_security_organization
Full name: azure-devops.azure_devops_advanced_security_org_enablement_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new status
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

estimate_pushers_that_would_be_added_customer_usage_if_advanced_security_was_enabled_this_organization Read

Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/management/meterUsageEstimate/default (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.estimate_pushers_that_would_be_added_customer_usage_if_advanced_security_was_enabled_this_organization
Full name: azure-devops.azure_devops_advanced_security_org_meter_usage_estimate_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`plan`	string	no	The plan to query.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_commiters_used_when_calculating_billing_information Read

Get commiters used when calculating billing information. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/_apis/management/meterusage/default (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.get_commiters_used_when_calculating_billing_information
Full name: azure-devops.azure_devops_advanced_security_meter_usage_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`plan`	string	no	The plan to query. Plans supported: CodeSecurity and SecretProtection. This is a mandatory parameter.
`billing_date`	string	no	The date to query, or if not provided, today
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_current_status_advanced_security_project Read

Get the current status of Advanced Security for a project Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.get_current_status_advanced_security_project
Full name: azure-devops.azure_devops_advanced_security_project_enablement_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`include_all_properties`	boolean	no	When true, also determine if pushes are blocked if they contain secrets
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_status_advanced_security_project Read

Update the status of Advanced Security for the project Official Azure DevOps REST API 7.2 endpoint: PATCH https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.update_status_advanced_security_project
Full name: azure-devops.azure_devops_advanced_security_project_enablement_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new status
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

estimate_pushers_that_would_be_added_customer_usage_if_advanced_security_was_enabled_this_project Read

Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this project. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/meterUsageEstimate/default (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.estimate_pushers_that_would_be_added_customer_usage_if_advanced_security_was_enabled_this_project
Full name: azure-devops.azure_devops_advanced_security_project_meter_usage_estimate_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan`	string	no	query parameter `plan`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

determines_if_code_security_secret_protection_and_their_features_are_enabled_repository Read

Determines if Code Security, Secret Protection, and their features are enabled for the repository. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/repositories/{repository}/enablement (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.determines_if_code_security_secret_protection_and_their_features_are_enabled_repository
Full name: azure-devops.azure_devops_advanced_security_repo_enablement_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	The name or ID of the repository
`include_all_properties`	boolean	no	When true, will also determine if pushes are blocked when secrets are detected
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_enablement_status_code_security_and_secret_protection_along_with_their_respective_features_given_repository Read

Update the enablement status of Code Security and Secret Protection, along with their respective features, for a given repository. Official Azure DevOps REST API 7.2 endpoint: PATCH https://advsec.dev.azure.com/{organization}/{project}/_apis/management/repositories/{repository}/enablement (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.update_enablement_status_code_security_and_secret_protection_along_with_their_respective_features_given_repository
Full name: azure-devops.azure_devops_advanced_security_repo_enablement_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	new status
`project`	string	yes	Project ID or project name
`repository`	string	yes	Name or ID of the repository
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

estimate_pushers_that_would_be_added_customer_usage_if_advanced_security_was_enabled_this_repository Read

Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this repository. Official Azure DevOps REST API 7.2 endpoint: GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/repositories/{repository}/meterUsageEstimate/default (spec: advancedSecurity/7.2/management.json).

Lua path: app.integrations.azure_devops.estimate_pushers_that_would_be_added_customer_usage_if_advanced_security_was_enabled_this_repository
Full name: azure-devops.azure_devops_advanced_security_repo_meter_usage_estimate_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	The name or ID of the repository
`plan`	string	no	The plan to query.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

batch_api_authorize_unauthorize_list_definitions_multiple_resources Write

Batch API to authorize/unauthorize a list of definitions for a multiple resources. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/pipelinepermissions (spec: approvalsAndChecks/7.2/pipelinePermissions.json).

Lua path: app.integrations.azure_devops.batch_api_authorize_unauthorize_list_definitions_multiple_resources
Full name: azure-devops.azure_devops_approvals_and_checks_pipeline_permissions_update_pipeline_permisions_for_resources

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

given_resourcetype_and_resourceid_returns_authorized_definitions_that_resource Read

Given a ResourceType and ResourceId, returns authorized definitions for that resource. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/pipelinepermissions/{resourceType}/{resourceId} (spec: approvalsAndChecks/7.2/pipelinePermissions.json).

Lua path: app.integrations.azure_devops.given_resourcetype_and_resourceid_returns_authorized_definitions_that_resource
Full name: azure-devops.azure_devops_approvals_and_checks_pipeline_permissions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`resource_type`	string	yes	path parameter `resourceType`.
`resource_id`	string	yes	path parameter `resourceId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

authorizes_unauthorizes_list_definitions_given_resource Write

Authorizes/Unauthorizes a list of definitions for a given resource. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/pipelinepermissions/{resourceType}/{resourceId} (spec: approvalsAndChecks/7.2/pipelinePermissions.json).

Lua path: app.integrations.azure_devops.authorizes_unauthorizes_list_definitions_given_resource
Full name: azure-devops.azure_devops_approvals_and_checks_pipeline_permissions_update_pipeline_permisions_for_resource

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`resource_type`	string	yes	path parameter `resourceType`.
`resource_id`	string	yes	path parameter `resourceId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_check_configuration_by_resource_type_and_id Read

Get Check configuration by resource type and id Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.get_check_configuration_by_resource_type_and_id
Full name: azure-devops.azure_devops_approvals_and_checks_check_configurations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`resource_type`	string	no	resource type
`resource_id`	string	no	resource id
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_check_configuration Read

Add a check configuration Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.add_check_configuration
Full name: azure-devops.azure_devops_approvals_and_checks_check_configurations_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_check_configuration_by_id Read

Get Check configuration by Id Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id} (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.get_check_configuration_by_id
Full name: azure-devops.azure_devops_approvals_and_checks_check_configurations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	number	yes	path parameter `id`.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_check_configuration Read

Update check configuration Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id} (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.update_check_configuration
Full name: azure-devops.azure_devops_approvals_and_checks_check_configurations_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	check configuration
`project`	string	yes	Project ID or project name
`id`	number	yes	check configuration id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_check_configuration_by_id Read

Delete check configuration by id Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id} (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.delete_check_configuration_by_id
Full name: azure-devops.azure_devops_approvals_and_checks_check_configurations_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	number	yes	check configuration id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_check_configurations_multiple_resources_by_resource_type_and_id Read

Get check configurations for multiple resources by resource type and id. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.get_check_configurations_multiple_resources_by_resource_type_and_id
Full name: azure-devops.azure_devops_approvals_and_checks_check_configurations_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of resources.
`project`	string	yes	Project ID or project name
`expand`	string	no	The properties that should be expanded in the list of check configurations.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

initiate_evaluation_check_pipeline Read

Initiate an evaluation for a check in a pipeline Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.initiate_evaluation_check_pipeline
Full name: azure-devops.azure_devops_approvals_and_checks_check_evaluations_evaluate

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_details_specific_check_evaluation Read

Get details for a specific check evaluation Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs/{checkSuiteId} (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.get_details_specific_check_evaluation
Full name: azure-devops.azure_devops_approvals_and_checks_check_evaluations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`check_suite_id`	string	yes	path parameter `checkSuiteId`.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_check_run_check_suite_following_update_actions_are_supported_rerun_allows_rerun_already_completed_check_if_check_retry_interval_is_0_bypass_applied_check_which_has_not_already_been_bypassed_and_whose_check_suite_is_not_completed_yet

Read

Update a check run of a check suite Following update actions are supported: * rerun - allows to rerun an already completed check, if the check retry interval is 0 * bypass - applied on a check which has not already been bypassed and whose check suite is not completed yet Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs/{checkSuiteId} (spec: approvalsAndChecks/7.2/pipelinesChecks.json).

Lua path: app.integrations.azure_devops.update_check_run_check_suite_following_update_actions_are_supported_rerun_allows_rerun_already_completed_check_if_check_retry_interval_is_0_bypass_applied_check_which_has_not_already_been_bypassed_and_whose_check_suite_is_not_completed_yet
Full name: azure-devops.azure_devops_approvals_and_checks_check_evaluations_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`check_suite_id`	string	yes	path parameter `checkSuiteId`.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

list_approvals_this_can_be_used_get_set_pending_approvals_pipeline_user_or_resource Read

List Approvals. This can be used to get a set of pending approvals in a pipeline, on an user or for a resource.. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals (spec: approvalsAndChecks/7.2/pipelinesapproval.json).

Lua path: app.integrations.azure_devops.list_approvals_this_can_be_used_get_set_pending_approvals_pipeline_user_or_resource
Full name: azure-devops.azure_devops_approvals_and_checks_approvals_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`approval_ids`	string	no	List of approval Ids to get.
`expand`	string	no	Include these additional details in the returned objects.
`assigned_to`	string	no	List of user Ids approvals assigned to. Accepts user Ids, user descriptors or user emails.
`state`	string	no	Approval status. Returns approvals of any status if not provided
`top`	number	no	Maximum number of approvals to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_approvals Read

Update approvals. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals (spec: approvalsAndChecks/7.2/pipelinesapproval.json).

Lua path: app.integrations.azure_devops.update_approvals
Full name: azure-devops.azure_devops_approvals_and_checks_approvals_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_approval Read

Get an approval. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals/{approvalId} (spec: approvalsAndChecks/7.2/pipelinesapproval.json).

Lua path: app.integrations.azure_devops.get_approval
Full name: azure-devops.azure_devops_approvals_and_checks_approvals_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`approval_id`	string	yes	Id of the approval.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_all_service_wide_feed_creation_and_administration_permissions Read

Get all service-wide feed creation and administration permissions. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/_apis/packaging/globalpermissions (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_all_service_wide_feed_creation_and_administration_permissions
Full name: azure-devops.azure_devops_artifacts_service_settings_get_global_permissions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`include_ids`	boolean	no	Set to true to add IdentityIds to the permission objects.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_service_wide_permissions_that_govern_feed_creation_and_administration Read

Set service-wide permissions that govern feed creation and administration. Official Azure DevOps REST API 7.2 endpoint: PATCH https://feeds.dev.azure.com/{organization}/_apis/packaging/globalpermissions (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.set_service_wide_permissions_that_govern_feed_creation_and_administration
Full name: azure-devops.azure_devops_artifacts_service_settings_set_global_permissions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	New permissions for the organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_provenance_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Gets provenance for a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/Versions/{packageVersionId}/provenance (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.gets_provenance_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_artifact_details_get_package_version_provenance

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	Id of the package (GUID Id, not name).
`package_version_id`	string	yes	Id of the package version (GUID Id, not name).
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_packaging_feeds_feedid_packages_packageid_versionmetricsbatch Read

POST /{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versionmetricsbatch Official Azure DevOps REST API 7.2 endpoint: POST https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versionmetricsbatch (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_packaging_feeds_feedid_packages_packageid_versionmetricsbatch
Full name: azure-devops.azure_devops_artifacts_artifact_details_query_package_version_metrics

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`feed_id`	string	yes	path parameter `feedId`.
`package_id`	string	yes	path parameter `packageId`.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_package_versions_optionally_filtering_by_state_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get a list of package versions, optionally filtering by state. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_list_package_versions_optionally_filtering_by_state_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_artifact_details_get_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	Id of the package (GUID Id, not name).
`project`	string	yes	Project ID or project name
`include_urls`	boolean	no	True to include urls for each version. Default is true.
`is_listed`	boolean	no	Only applicable for NuGet packages. If false, delisted package versions will be returned.
`is_deleted`	boolean	no	If set specifies whether to return only deleted or non-deleted versions of packages in the response. Default is unset (return all versions).
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_details_about_specific_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get details about a specific package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions/{packageVersionId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_details_about_specific_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_artifact_details_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	Id of the package (GUID Id, not name).
`package_version_id`	string	yes	Id of the package version (GUID Id, not name).
`project`	string	yes	Project ID or project name
`include_urls`	boolean	no	True to include urls for each version. Default is true.
`is_listed`	boolean	no	Only applicable for NuGet packages. If false, delisted package versions will be returned.
`is_deleted`	boolean	no	This does not have any effect on the requested package version, for other versions returned specifies whether to return only deleted or non-deleted versions of packages in the response. Default is unset (return all versions).
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_packages_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Query for packages within the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.query_packages_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_recycle_bin_get_recycle_bin_packages

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`protocol_type`	string	no	Type of package (e.g. NuGet, npm, ...).
`package_name_query`	string	no	Filter to packages matching this name.
`include_urls`	boolean	no	True to return REST Urls with the response. Default is True.
`top`	number	no	Get the top N packages.
`skip`	number	no	Skip the first N packages.
`include_all_versions`	boolean	no	True to return all versions of the package in the response. Default is false (latest version only).
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

queues_job_remove_all_package_versions_from_feed_recycle_bin Read

Queues a job to remove all package versions from a feed's recycle bin Official Azure DevOps REST API 7.2 endpoint: DELETE https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.queues_job_remove_all_package_versions_from_feed_recycle_bin
Full name: azure-devops.azure_devops_artifacts_recycle_bin_empty_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_and_all_its_versions_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package and all its versions within the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_information_about_package_and_all_its_versions_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_recycle_bin_get_recycle_bin_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	The package Id (GUID Id, not the package name).
`project`	string	yes	Project ID or project name
`include_urls`	boolean	no	True to return REST Urls with the response. Default is True.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_package_versions_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get a list of package versions within the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}/Versions (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_list_package_versions_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_recycle_bin_get_recycle_bin_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	The package Id (GUID Id, not the package name).
`project`	string	yes	Project ID or project name
`include_urls`	boolean	no	True to return REST Urls with the response. Default is True.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version within the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}/Versions/{packageVersionId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_within_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_recycle_bin_get_recycle_bin_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	The package Id (GUID Id, not the package name).
`package_version_id`	string	yes	The package version Id 9guid Id, not the version string).
`project`	string	yes	Project ID or project name
`include_urls`	boolean	no	True to return REST Urls with the response. Default is True.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_batch_package_changes_made_feed_changes_returned_are_most_recent_change_so_if_add_is_followed_by_update_before_you_begin_enumerating_you_ll_only_see_one_change_batch_while_consuming_batches_using_continuation_token_you_may_see_changes_same_package_version_multiple_times_if_they_are_happening_you_enumerate_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Get a batch of package changes made to a feed. The changes returned are 'most recent change' so if an Add is followed by an Update before you begin enumerating, you'll only see one change in the batch. While consuming batches using the continuation token, you may see changes to the same package version multiple times if they are happening as you enumerate. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packagechanges (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_batch_package_changes_made_feed_changes_returned_are_most_recent_change_so_if_add_is_followed_by_update_before_you_begin_enumerating_you_ll_only_see_one_change_batch_while_consuming_batches_using_continuation_token_you_may_see_changes_same_package_version_multiple_times_if_they_are_happening_you_enumerate_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_change_tracking_get_package_changes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`continuation_token`	number	no	A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
`batch_size`	number	no	Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_packaging_feeds_feedid_packagemetricsbatch Read

POST /{organization}/{project}/_apis/packaging/Feeds/{feedId}/packagemetricsbatch Official Azure DevOps REST API 7.2 endpoint: POST https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packagemetricsbatch (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_packaging_feeds_feedid_packagemetricsbatch
Full name: azure-devops.azure_devops_artifacts_artifact_details_query_package_metrics

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`feed_id`	string	yes	path parameter `feedId`.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_details_about_all_packages_feed_use_various_filters_include_or_exclude_information_from_result_set_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packages (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_details_about_all_packages_feed_use_various_filters_include_or_exclude_information_from_result_set_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_artifact_details_get_packages

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`protocol_type`	string	no	One of the supported artifact package types.
`package_name_query`	string	no	Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.
`normalized_package_name`	string	no	[Obsolete] Used for legacy scenarios and may be removed in future versions.
`include_urls`	boolean	no	True to return REST Urls with the response. Default is True.
`include_all_versions`	boolean	no	True to return all versions of the package in the response. Default is false (latest version only).
`is_listed`	boolean	no	Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
`get_top_package_versions`	boolean	no	Changes the behavior of $top and $skip to return all versions of each package up to $top. Must be used in conjunction with includeAllVersions=true
`is_release`	boolean	no	Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).
`include_description`	boolean	no	Return the description for every version of each package in the response. Default is False.
`top`	number	no	Get the top N packages (or package versions where getTopPackageVersions=true)
`skip`	number	no	Skip the first N packages (or package versions where getTopPackageVersions=true)
`include_deleted`	boolean	no	Return deleted or unpublished versions of packages in the response. Default is False.
`is_cached`	boolean	no	[Obsolete] Used for legacy scenarios and may be removed in future versions.
`direct_upstream_id`	string	no	Filter results to return packages from a specific upstream.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_details_about_specific_package_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get details about a specific package. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packages/{packageId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_details_about_specific_package_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_artifact_details_get_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	The package Id (GUID Id, not the package name).
`project`	string	yes	Project ID or project name
`include_all_versions`	boolean	no	True to return all versions of the package in the response. Default is false (latest version only).
`include_urls`	boolean	no	True to return REST Urls with the response. Default is True.
`is_listed`	boolean	no	Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
`is_release`	boolean	no	Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).
`include_deleted`	boolean	no	Return deleted or unpublished versions of packages in the response. Default is False.
`include_description`	boolean	no	Return the description for every version of each package in the response. Default is False.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_permissions_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get the permissions for a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/permissions (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_permissions_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_management_get_feed_permissions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`include_ids`	boolean	no	True to include user Ids in the response. Default is false.
`exclude_inherited_permissions`	boolean	no	True to only return explicitly set permissions on the feed. Default is false.
`identity_descriptor`	string	no	Filter permissions to the provided identity.
`include_deleted_feeds`	boolean	no	If includeDeletedFeeds is true, then feedId must be specified by name and not by Guid.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_permissions_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Update the permissions on a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/permissions (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.update_permissions_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_management_set_feed_permissions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Permissions to set.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_retention_policy_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get the retention policy for a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/retentionpolicies (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_retention_policy_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_retention_policies_get_retention_policy

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_retention_policy_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Set the retention policy for a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PUT https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/retentionpolicies (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.set_retention_policy_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_retention_policies_set_retention_policy

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Feed retention policy.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_retention_policy_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete the retention policy for a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/retentionpolicies (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.delete_retention_policy_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_retention_policies_delete_retention_policy

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_views_feed_project_parameter_must_be_supplied_if_feed_was_created_project Read

Get all views for a feed. The project parameter must be supplied if the feed was created in a project. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_all_views_feed_project_parameter_must_be_supplied_if_feed_was_created_project
Full name: azure-devops.azure_devops_artifacts_feed_management_get_feed_views

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_view_referenced_feed_project_parameter_must_be_supplied_if_feed_was_created_project Write

Create a new view on the referenced feed. The project parameter must be supplied if the feed was created in a project. Official Azure DevOps REST API 7.2 endpoint: POST https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.create_new_view_referenced_feed_project_parameter_must_be_supplied_if_feed_was_created_project
Full name: azure-devops.azure_devops_artifacts_feed_management_create_feed_view

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	View to be created.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_view_by_id_project_parameter_must_be_supplied_if_feed_was_created_project Read

Get a view by Id. The project parameter must be supplied if the feed was created in a project. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views/{viewId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_view_by_id_project_parameter_must_be_supplied_if_feed_was_created_project
Full name: azure-devops.azure_devops_artifacts_feed_management_get_feed_view

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`view_id`	string	yes	Name or Id of the view.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_view_project_parameter_must_be_supplied_if_feed_was_created_project Write

Update a view. The project parameter must be supplied if the feed was created in a project. Official Azure DevOps REST API 7.2 endpoint: PATCH https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views/{viewId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.update_view_project_parameter_must_be_supplied_if_feed_was_created_project
Full name: azure-devops.azure_devops_artifacts_feed_management_update_feed_view

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	New settings to apply to the specified view.
`feed_id`	string	yes	Name or Id of the feed.
`view_id`	string	yes	Name or Id of the view.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_feed_view_project_parameter_must_be_supplied_if_feed_was_created_project Write

Delete a feed view. The project parameter must be supplied if the feed was created in a project. Official Azure DevOps REST API 7.2 endpoint: DELETE https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views/{viewId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.delete_feed_view_project_parameter_must_be_supplied_if_feed_was_created_project
Full name: azure-devops.azure_devops_artifacts_feed_management_delete_feed_view

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`view_id`	string	yes	Name or Id of the view.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_determine_which_feeds_have_changed_since_last_call_tracked_through_provided_continuationtoken_only_changes_feed_itself_are_returned_and_impact_continuationtoken_not_additions_or_alterations_packages_within_feeds_if_project_parameter_is_present_gets_all_feed_changes_given_project_if_omitted_gets_all_feed_changes_organization

Write

Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds. If the project parameter is present, gets all feed changes in the given project. If omitted, gets all feed changes in the organization. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedchanges (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.query_determine_which_feeds_have_changed_since_last_call_tracked_through_provided_continuationtoken_only_changes_feed_itself_are_returned_and_impact_continuationtoken_not_additions_or_alterations_packages_within_feeds_if_project_parameter_is_present_gets_all_feed_changes_given_project_if_omitted_gets_all_feed_changes_organization
Full name: azure-devops.azure_devops_artifacts_change_tracking_get_feed_changes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`include_deleted`	boolean	no	If true, get changes for all feeds including deleted feeds. The default value is false.
`continuation_token`	number	no	A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
`batch_size`	number	no	Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_feed_determine_its_current_state_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Query a feed to determine its current state. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedchanges/{feedId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.query_feed_determine_its_current_state_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_change_tracking_get_feed_change

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_feeds_within_recycle_bin_if_project_parameter_is_present_gets_all_feeds_recycle_bin_given_project_if_omitted_gets_all_feeds_recycle_bin_organization

Read

Query for feeds within the recycle bin. If the project parameter is present, gets all feeds in recycle bin in the given project. If omitted, gets all feeds in recycle bin in the organization. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedrecyclebin (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.query_feeds_within_recycle_bin_if_project_parameter_is_present_gets_all_feeds_recycle_bin_given_project_if_omitted_gets_all_feeds_recycle_bin_organization
Full name: azure-devops.azure_devops_artifacts_feed_recycle_bin_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restores_deleted_feed_and_all_its_packages_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restores a deleted feed and all of its packages. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedrecyclebin/{feedId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.restores_deleted_feed_and_all_its_packages_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_recycle_bin_restore_deleted_feed

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

permanently_delete_feed_and_all_its_packages_action_is_irreversible_and_package_content_will_be_deleted_immediately_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Permanently delete a feed and all of its packages. The action is irreversible and the package content will be deleted immediately. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedrecyclebin/{feedId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.permanently_delete_feed_and_all_its_packages_action_is_irreversible_and_package_content_will_be_deleted_immediately_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_recycle_bin_permanent_delete_feed

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_feeds_account_where_you_have_provided_role_access_if_project_parameter_is_present_gets_all_feeds_given_project_if_omitted_gets_all_feeds_organization

Read

Get all feeds in an account where you have the provided role access. If the project parameter is present, gets all feeds in the given project. If omitted, gets all feeds in the organization. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_all_feeds_account_where_you_have_provided_role_access_if_project_parameter_is_present_gets_all_feeds_given_project_if_omitted_gets_all_feeds_organization
Full name: azure-devops.azure_devops_artifacts_feed_management_get_feeds

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`feed_role`	string	no	Filter by this role, either Administrator(4), Contributor(3), or Reader(2) level permissions.
`include_deleted_upstreams`	boolean	no	Include upstreams that have been deleted in the response.
`include_urls`	boolean	no	Resolve names if true
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_feed_container_various_package_types_feeds_can_be_created_project_if_project_parameter_is_included_request_url_if_project_parameter_is_omitted_feed_will_not_be_associated_with_project_and_will_be_created_at_organization_level

Write

Create a feed, a container for various package types. Feeds can be created in a project if the project parameter is included in the request url. If the project parameter is omitted, the feed will not be associated with a project and will be created at the organization level. Official Azure DevOps REST API 7.2 endpoint: POST https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.create_feed_container_various_package_types_feeds_can_be_created_project_if_project_parameter_is_included_request_url_if_project_parameter_is_omitted_feed_will_not_be_associated_with_project_and_will_be_created_at_organization_level
Full name: azure-devops.azure_devops_artifacts_feed_management_create_feed

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A JSON object containing both required and optional attributes for the feed. Name is the only required value.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_settings_specific_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get the settings for a specific feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.get_settings_specific_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_management_get_feed

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`include_deleted_upstreams`	boolean	no	Include upstreams that have been deleted in the response.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

change_attributes_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Change the attributes of a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.change_attributes_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_management_update_feed

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A JSON object containing the feed settings to be updated.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

remove_feed_and_all_its_packages_feed_moves_recycle_bin_and_is_reversible_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Remove a feed and all its packages. The feed moves to the recycle bin and is reversible. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId} (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.remove_feed_and_all_its_packages_feed_moves_recycle_bin_and_is_reversible_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_feed_management_delete_feed

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

generate_svg_badge_latest_version_package_generated_svg_is_typically_used_image_html_link_which_takes_users_feed_containing_package_accelerate_discovery_and_consumption_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Generate a SVG badge for the latest version of a package. The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://feeds.dev.azure.com/{organization}/{project}/_apis/public/packaging/Feeds/{feedId}/Packages/{packageId}/badge (spec: artifacts/7.2/feed.json).

Lua path: app.integrations.azure_devops.generate_svg_badge_latest_version_package_generated_svg_is_typically_used_image_html_link_which_takes_users_feed_containing_package_accelerate_discovery_and_consumption_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_artifact_details_get_badge

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or Id of the feed.
`package_id`	string	yes	Id of the package (GUID Id, not name).
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_session_wrapper_around_feed_that_can_store_additional_metadata_packages_published_it Write

Creates a session, a wrapper around a feed that can store additional metadata on the packages published to it. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/provenance/session/{protocol} (spec: artifacts/7.2/provenance.json).

Lua path: app.integrations.azure_devops.creates_session_wrapper_around_feed_that_can_store_additional_metadata_packages_published_it
Full name: azure-devops.azure_devops_artifacts_provenance_create_session

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The feed and metadata for the session
`protocol`	string	yes	The protocol that the session will target
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version in the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_get_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version from the recycle bin to its associated feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_restore_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Set the 'Deleted' state to 'false' to restore the package to its feed.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_from_feed_moving_it_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version from the feed, moving it to the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.delete_package_version_from_feed_moving_it_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_delete_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete or restore several package versions from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/RecycleBin/packagesBatch (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_update_recycle_bin_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data. <c>Operation</c> must be <c>PermanentDelete</c> or <c>RestoreToFeed</c>
`feed_id`	string	yes	Feed which contains the packages to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`show_deleted`	boolean	no	True to show information for deleted package versions.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update state for a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.update_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_update_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Details to be updated.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

send_package_version_from_feed_its_paired_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Send a package version from the feed to its paired recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/cargo/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.send_package_version_from_feed_its_paired_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_delete_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package to delete.
`package_version`	string	yes	Version of the package to delete.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_upstreaming_behavior_package_within_context_feed Read

Get the upstreaming behavior of a package within the context of a feed Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/cargo/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.get_upstreaming_behavior_package_within_context_feed
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_get_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion

Read

Set the upstreaming behavior of a package within the context of a feed The package does not need to necessarily exist in the feed prior to setting the behavior. This assists with packages that are not yet ingested from an upstream, yet the feed owner wants to apply a specific behavior on the first ingestion. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/cargo/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_set_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`body`	object	yes	The behavior to apply to the package within the scope of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_packaging/packaging/feeds/{feedId}/cargo/packagesbatch (spec: artifactsPackageTypes/7.2/cargoApi-AzureArtifacts.json).

Lua path: app.integrations.azure_devops.update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_cargo_update_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/maven/packagesbatch (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_update_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Feed which contains the packages to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

fulfills_maven_package_file_download_requests_by_either_returning_url_requested_package_file_or_case_server_onprem_returning_content_stream_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/maven/{groupId}/{artifactId}/{version}/{fileName}/content (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.fulfills_maven_package_file_download_requests_by_either_returning_url_requested_package_file_or_case_server_onprem_returning_content_stream_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_download_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`group_id`	string	yes	GroupId of the maven package
`artifact_id`	string	yes	ArtifactId of the maven package
`version`	string	yes	Version of the package
`file_name`	string	yes	File name to download
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version in the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/RecycleBin/groups/{groupId}/artifacts/{artifactId}/versions/{version} (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_get_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	Name or ID of the feed.
`group_id`	string	yes	Group ID of the package.
`artifact_id`	string	yes	Artifact ID of the package.
`version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version from the recycle bin to its associated feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/RecycleBin/groups/{groupId}/artifacts/{artifactId}/versions/{version} (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_restore_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Set the 'Deleted' property to false to restore the package.
`feed`	string	yes	Name or ID of the feed.
`group_id`	string	yes	Group ID of the package.
`artifact_id`	string	yes	Artifact ID of the package.
`version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

permanently_delete_package_from_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Permanently delete a package from a feed's recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/RecycleBin/groups/{groupId}/artifacts/{artifactId}/versions/{version} (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.permanently_delete_package_from_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_delete_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	Name or ID of the feed.
`group_id`	string	yes	Group ID of the package.
`artifact_id`	string	yes	Artifact ID of the package.
`version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete or restore several package versions from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/RecycleBin/packagesBatch (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_update_recycle_bin_packages

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed`	string	yes	path parameter `feed`.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_upstreaming_behavior_package_within_context_feed Read

Get the upstreaming behavior of a package within the context of a feed Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/groups/{groupId}/artifacts/{artifactId}/upstreaming (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.get_upstreaming_behavior_package_within_context_feed
Full name: azure-devops.azure_devops_artifacts_package_types_maven_get_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	The name or id of the feed
`group_id`	string	yes	The group id of the package
`artifact_id`	string	yes	The artifact id of the package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion

Read

Set the upstreaming behavior of a package within the context of a feed The package does not need to necessarily exist in the feed prior to setting the behavior. This assists with packages that are not yet ingested from an upstream, yet the feed owner wants to apply a specific behavior on the first ingestion. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/groups/{groupId}/artifacts/{artifactId}/upstreaming (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion
Full name: azure-devops.azure_devops_artifacts_package_types_maven_set_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	The name or id of the feed
`group_id`	string	yes	path parameter `groupId`.
`artifact_id`	string	yes	path parameter `artifactId`.
`body`	object	yes	The behavior to apply to the package within the scope of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/groups/{groupId}/artifacts/{artifactId}/versions/{version} (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	Name or ID of the feed.
`group_id`	string	yes	Group ID of the package.
`artifact_id`	string	yes	Artifact ID of the package.
`version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`show_deleted`	boolean	no	True to show information for deleted packages.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update state for a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/groups/{groupId}/artifacts/{artifactId}/versions/{version} (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.update_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_update_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Details to be updated.
`feed`	string	yes	Name or ID of the feed.
`group_id`	string	yes	Group ID of the package.
`artifact_id`	string	yes	Artifact ID of the package.
`version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_from_feed_and_move_it_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version from the feed and move it to the feed's recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feed}/maven/groups/{groupId}/artifacts/{artifactId}/versions/{version} (spec: artifactsPackageTypes/7.2/maven.json).

Lua path: app.integrations.azure_devops.delete_package_version_from_feed_and_move_it_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_maven_delete_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed`	string	yes	Name or ID of the feed.
`group_id`	string	yes	Group ID of the package.
`artifact_id`	string	yes	Artifact ID of the package.
`version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

validates_whether_given_upstream_is_valid_add_custom_upstream_using_given_package_name Read

Validates whether the given upstream is valid to add as a custom upstream using the given package name. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/_apis/packaging/npm/validateupstream (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.validates_whether_given_upstream_is_valid_add_custom_upstream_using_given_package_name
Full name: azure-devops.azure_devops_artifacts_package_types_npm_validate_custom_public_upstream_source

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The upstream location (https URI) and package name to validate
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_scoped_package_version_such_scope_name_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a scoped package version (such as @scope/name). The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/@{packageScope}/{unscopedPackageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_information_about_scoped_package_version_such_scope_name_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_scoped_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the package (the 'scope' part of @scope/name).
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope/name).
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_state_npm_scoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update state for an npm scoped package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/@{packageScope}/{unscopedPackageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.update_state_npm_scoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_update_scoped_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated state for the package version.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	path parameter `packageScope`.
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope/name).
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

unpublish_scoped_package_version_such_scope_name_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Unpublish a scoped package version (such as @scope/name). The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/@{packageScope}/{unscopedPackageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.unpublish_scoped_package_version_such_scope_name_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_unpublish_scoped_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the package (the 'scope' part of @scope/name).
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope/name).
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete or restore several package versions from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/PackagesBatch (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_update_recycle_bin_packages

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_scoped_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a scoped package version in the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_information_about_scoped_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_scoped_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the package (the 'scope' part of @scope/name)
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope/name).
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_with_npm_scope_from_recycle_bin_its_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version with an npm scope from the recycle bin to its feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.restore_package_version_with_npm_scope_from_recycle_bin_its_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_restore_scoped_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the package (the 'scope' part of @scope/name).
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope/name).
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_with_npm_scope_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version with an npm scope from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.delete_package_version_with_npm_scope_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_delete_scoped_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the package (the 'scope' part of @scope/name).
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope/name).
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_unscoped_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about an unscoped package version in the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_information_about_unscoped_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_without_npm_scope_from_recycle_bin_its_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version without an npm scope from the recycle bin to its feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.restore_package_version_without_npm_scope_from_recycle_bin_its_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_restore_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_without_npm_scope_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version without an npm scope from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.delete_package_version_without_npm_scope_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_delete_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_upstreaming_behavior_scoped_package_within_context_feed Read

Get the upstreaming behavior of the (scoped) package within the context of a feed Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/@{packageScope}/{unscopedPackageName}/upstreaming (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_upstreaming_behavior_scoped_package_within_context_feed
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_package_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_scope`	string	yes	The scope of the package
`unscoped_package_name`	string	yes	The name of the scoped package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_upstreaming_behavior_scoped_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion

Read

Set the upstreaming behavior of a (scoped) package within the context of a feed The package does not need to necessarily exist in the feed prior to setting the behavior. This assists with packages that are not yet ingested from an upstream, yet the feed owner wants to apply a specific behavior on the first ingestion. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/@{packageScope}/{unscopedPackageName}/upstreaming (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.set_upstreaming_behavior_scoped_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion
Full name: azure-devops.azure_devops_artifacts_package_types_npm_set_scoped_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_scope`	string	yes	The scope of the package
`unscoped_package_name`	string	yes	The name of the scoped package
`body`	object	yes	The behavior to apply to the scoped package within the scope of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_scoped_npm_package_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get scoped npm package. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion}/content (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_scoped_npm_package_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_download_scoped_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the npm package (the @scope portion of @scope/packageName).
`unscoped_package_name`	string	yes	Name of the package without the scope component.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_readme_package_version_with_npm_scope_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get the Readme for a package version with an npm scope. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion}/readme (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_readme_package_version_with_npm_scope_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_scoped_package_readme

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_scope`	string	yes	Scope of the package (the 'scope' part of @scope\name)
`unscoped_package_name`	string	yes	Name of the package (the 'name' part of @scope\name)
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_upstreaming_behavior_unscoped_package_within_context_feed Read

Get the upstreaming behavior of the (unscoped) package within the context of a feed Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_upstreaming_behavior_unscoped_package_within_context_feed
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_scoped_package_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_upstreaming_behavior_scoped_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion

Read

Set the upstreaming behavior of a (scoped) package within the context of a feed The package does not need to necessarily exist in the feed prior to setting the behavior. This assists with packages that are not yet ingested from an upstream, yet the feed owner wants to apply a specific behavior on the first ingestion. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.set_upstreaming_behavior_scoped_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion
Full name: azure-devops.azure_devops_artifacts_package_types_npm_set_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`body`	object	yes	The behavior to apply to the scoped package within the scope of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_unscoped_npm_package_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get an unscoped npm package. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/{packageName}/versions/{packageVersion}/content (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_unscoped_npm_package_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_download_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_readme_package_version_that_has_no_npm_scope_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get the Readme for a package version that has no npm scope. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packages/{packageName}/versions/{packageVersion}/readme (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_readme_package_version_that_has_no_npm_scope_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_package_readme

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/packagesbatch (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_update_packages

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_unscoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about an unscoped package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.get_information_about_unscoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_state_unscoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update state for an unscoped package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.update_state_unscoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_update_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated state for the package version.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

unpublish_unscoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Unpublish an unscoped package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/npm/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/npm.json).

Lua path: app.integrations.azure_devops.unpublish_unscoped_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_npm_unpublish_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

view_package_version_deletion_recycled_status_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

View a package version's deletion/recycled status The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.view_package_version_deletion_recycled_status_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_get_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_from_feed_recycle_bin_back_into_active_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version from a feed's recycle bin back into the active feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.restore_package_version_from_feed_recycle_bin_back_into_active_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_restore_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Set the 'Deleted' member to 'false' to apply the restore operation
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_from_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version from a feed's recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.delete_package_version_from_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_delete_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete or restore several package versions from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/RecycleBin/packagesBatch (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_update_recycle_bin_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data. <c>Operation</c> must be <c>PermanentDelete</c> or <c>RestoreToFeed</c>
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_upstreaming_behavior_package_within_context_feed Read

Get the upstreaming behavior of a package within the context of a feed Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.get_upstreaming_behavior_package_within_context_feed
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_get_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion

Read

Set the upstreaming behavior of a package within the context of a feed The package does not need to necessarily exist in the feed prior to setting the behavior. This assists with packages that are not yet ingested from an upstream, yet the feed owner wants to apply a specific behavior on the first ingestion. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_set_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`body`	object	yes	The behavior to apply to the package within the scope of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`show_deleted`	boolean	no	True to include deleted packages in the response.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_mutable_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Set mutable state on a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.set_mutable_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_update_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	New state to apply to the referenced package.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package to update.
`package_version`	string	yes	Version of the package to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

send_package_version_from_feed_its_paired_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Send a package version from the feed to its paired recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.send_package_version_from_feed_its_paired_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_delete_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package to delete.
`package_version`	string	yes	Version of the package to delete.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

download_package_version_directly_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Download a package version directly. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/versions/{packageVersion}/content (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.download_package_version_directly_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_download_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`source_protocol_version`	string	no	Unused
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/nuget/packagesbatch (spec: artifactsPackageTypes/7.2/nuGet.json).

Lua path: app.integrations.azure_devops.update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_nu_get_update_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version in the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_get_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version from the recycle bin to its associated feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_restore_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Set the 'Deleted' state to 'false' to restore the package to its feed.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_from_feed_moving_it_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version from the feed, moving it to the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.delete_package_version_from_feed_moving_it_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_delete_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete or restore several package versions from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/RecycleBin/packagesBatch (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_update_recycle_bin_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data. <c>Operation</c> must be <c>PermanentDelete</c> or <c>RestoreToFeed</c>
`feed_id`	string	yes	Feed which contains the packages to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_upstreaming_behavior_package_within_context_feed Read

Get the upstreaming behavior of a package within the context of a feed Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.get_upstreaming_behavior_package_within_context_feed
Full name: azure-devops.azure_devops_artifacts_package_types_python_get_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion

Read

Set the upstreaming behavior of a package within the context of a feed The package does not need to necessarily exist in the feed prior to setting the behavior. This assists with packages that are not yet ingested from an upstream, yet the feed owner wants to apply a specific behavior on the first ingestion. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/upstreaming (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.set_upstreaming_behavior_package_within_context_feed_package_does_not_need_necessarily_exist_feed_prior_setting_behavior_this_assists_with_packages_that_are_not_yet_ingested_from_upstream_yet_feed_owner_wants_apply_specific_behavior_first_ingestion
Full name: azure-devops.azure_devops_artifacts_package_types_python_set_upstreaming_behavior

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	The name or id of the feed
`package_name`	string	yes	The name of the package
`body`	object	yes	The behavior to apply to the package within the scope of the feed
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`show_deleted`	boolean	no	True to show information for deleted package versions.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update state for a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.update_state_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_update_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Details to be updated.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_moving_it_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version, moving it to the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.delete_package_version_moving_it_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_delete_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

download_python_package_file_directly_this_api_is_intended_manual_ui_download_options_not_programmatic_access_and_scripting_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Download a python package file directly. This API is intended for manual UI download options, not for programmatic access and scripting. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/versions/{packageVersion}/{fileName}/content (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.download_python_package_file_directly_this_api_is_intended_manual_ui_download_options_not_programmatic_access_and_scripting_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_download_package

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`file_name`	string	yes	Name of the file in the package
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/pypi/packagesbatch (spec: artifactsPackageTypes/7.2/pyPiApi.json).

Lua path: app.integrations.azure_devops.update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_python_update_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Get information about a package version in the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.get_information_about_package_version_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_get_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Restore a package version from the recycle bin to its associated feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.restore_package_version_from_recycle_bin_its_associated_feed_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_restore_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Set the 'Deleted' property to 'false' to restore the package.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/RecycleBin/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.delete_package_version_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_delete_package_version_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete or restore several package versions from the recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/RecycleBin/packagesBatch (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.delete_or_restore_several_package_versions_from_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_update_recycle_bin_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data. <c>Operation</c> must be <c>PermanentDelete</c> or <c>RestoreToFeed</c>
`feed_id`	string	yes	Feed which contains the packages to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

show_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Read

Show information about a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: GET https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.show_information_about_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_get_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`show_deleted`	boolean	no	True to show information for deleted versions
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_information_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update information for a package version. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.update_information_package_version_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_update_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_package_version_from_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Delete a package version from a feed's recycle bin. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/packages/{packageName}/versions/{packageVersion} (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.delete_package_version_from_feed_recycle_bin_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_delete_package_version

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`feed_id`	string	yes	Name or ID of the feed.
`package_name`	string	yes	Name of the package.
`package_version`	string	yes	Version of the package.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request

Write

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request. Official Azure DevOps REST API 7.2 endpoint: POST https://pkgs.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}/upack/packagesbatch (spec: artifactsPackageTypes/7.2/universal.json).

Lua path: app.integrations.azure_devops.update_several_packages_from_single_feed_single_request_updates_packages_do_not_happen_atomically_project_parameter_must_be_supplied_if_feed_was_created_project_if_feed_is_not_associated_with_any_project_omit_project_parameter_from_request
Full name: azure-devops.azure_devops_artifacts_package_types_universal_update_package_versions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Information about the packages to update, the operation to perform, and its associated data.
`feed_id`	string	yes	Name or ID of the feed.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_auditable_actions_filterable_by_area Read

Get all auditable actions filterable by area. Official Azure DevOps REST API 7.2 endpoint: GET https://auditservice.dev.azure.com/{organization}/_apis/audit/actions (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.get_all_auditable_actions_filterable_by_area
Full name: azure-devops.azure_devops_audit_actions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`area_name`	string	no	Optional. Get actions scoped to area
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

queries_audit_log_entries Read

Queries audit log entries Official Azure DevOps REST API 7.2 endpoint: GET https://auditservice.dev.azure.com/{organization}/_apis/audit/auditlog (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.queries_audit_log_entries
Full name: azure-devops.azure_devops_audit_audit_log_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`start_time`	string	no	Start time of download window. Optional
`end_time`	string	no	End time of download window. Optional
`batch_size`	number	no	Max number of results to return. Optional
`continuation_token`	string	no	Token used for returning next set of results from previous query. Optional
`skip_aggregation`	boolean	no	Skips aggregating events and leaves them as individual entries instead. By default events are aggregated. Event types that are aggregated: AuditLog.AccessLog.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

downloads_audit_log_entries Read

Downloads audit log entries. Official Azure DevOps REST API 7.2 endpoint: GET https://auditservice.dev.azure.com/{organization}/_apis/audit/downloadlog (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.downloads_audit_log_entries
Full name: azure-devops.azure_devops_audit_download_log_download_log

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`format`	string	no	File format for download. Can be "json" or "csv".
`start_time`	string	no	Start time of download window. Optional
`end_time`	string	no	End time of download window. Optional
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

return_all_audit_streams_scoped_organization Read

Return all Audit Streams scoped to an organization Official Azure DevOps REST API 7.2 endpoint: GET https://auditservice.dev.azure.com/{organization}/_apis/audit/streams (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.return_all_audit_streams_scoped_organization
Full name: azure-devops.azure_devops_audit_streams_query_all_streams

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_audit_stream Read

Create new Audit Stream Official Azure DevOps REST API 7.2 endpoint: POST https://auditservice.dev.azure.com/{organization}/_apis/audit/streams (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.create_new_audit_stream
Full name: azure-devops.azure_devops_audit_streams_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Stream entry
`days_to_backfill`	number	no	The number of days of previously recorded audit data that will be replayed into the stream. A value of zero will result in only new events being streamed.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_existing_audit_stream Write

Update existing Audit Stream Official Azure DevOps REST API 7.2 endpoint: PUT https://auditservice.dev.azure.com/{organization}/_apis/audit/streams (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.update_existing_audit_stream
Full name: azure-devops.azure_devops_audit_streams_update_stream

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Stream entry
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

return_audit_stream_with_id_streamid_if_one_exists_otherwise_throw Read

Return Audit Stream with id of streamId if one exists otherwise throw Official Azure DevOps REST API 7.2 endpoint: GET https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId} (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.return_audit_stream_with_id_streamid_if_one_exists_otherwise_throw
Full name: azure-devops.azure_devops_audit_streams_query_stream_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`stream_id`	number	yes	Id of stream entry to retrieve
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_existing_audit_stream_status Write

Update existing Audit Stream status Official Azure DevOps REST API 7.2 endpoint: PUT https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId} (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.update_existing_audit_stream_status
Full name: azure-devops.azure_devops_audit_streams_update_status

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`stream_id`	number	yes	Id of stream entry to be updated
`status`	string	no	Status of the stream
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

delete_audit_stream Read

Delete Audit Stream Official Azure DevOps REST API 7.2 endpoint: DELETE https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId} (spec: audit/7.2/audit.json).

Lua path: app.integrations.azure_devops.delete_audit_stream
Full name: azure-devops.azure_devops_audit_streams_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`stream_id`	number	yes	Id of stream entry to delete
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_controller_optionally_filtered_by_name Read

Gets controller, optionally filtered by name Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/build/controllers (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_controller_optionally_filtered_by_name
Full name: azure-devops.azure_devops_build_controllers_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`name`	string	no	query parameter `name`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_controller Read

Gets a controller Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/build/controllers/{controllerId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_controller
Full name: azure-devops.azure_devops_build_controllers_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`controller_id`	number	yes	path parameter `controllerId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_information_about_build_resources_system Read

Gets information about build resources in the system. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/build/resourceusage (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_information_about_build_resources_system
Full name: azure-devops.azure_devops_build_resource_usage_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_retention_history_project_collection_this_includes_pipelines_that_have_custom_retention_rules_that_may_prevent_retention_job_from_cleaning_them_up_runs_per_pipeline_with_retention_type_files_associated_with_pipelines_owned_by_collection_with_retention_type_and_number_files_per_pipeline

Read

Returns the retention history for the project collection. This includes pipelines that have custom retention rules that may prevent the retention job from cleaning them up, runs per pipeline with retention type, files associated with pipelines owned by the collection with retention type, and the number of files per pipeline. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/build/retention/history (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.returns_retention_history_project_collection_this_includes_pipelines_that_have_custom_retention_rules_that_may_prevent_retention_job_from_cleaning_them_up_runs_per_pipeline_with_retention_type_files_associated_with_pipelines_owned_by_collection_with_retention_type_and_number_files_per_pipeline
Full name: azure-devops.azure_devops_build_history_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`days_to_lookback`	number	no	query parameter `daysToLookback`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

this_endpoint_is_deprecated_please_see_build_status_rest_endpoint Read

This endpoint is deprecated. Please see the Build Status REST endpoint. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/public/build/definitions/{project}/{definitionId}/badge (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.this_endpoint_is_deprecated_please_see_build_status_rest_endpoint
Full name: azure-devops.azure_devops_build_badge_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	The project ID or name.
`definition_id`	number	yes	The ID of the definition.
`branch_name`	string	no	The name of the branch.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_apis_build_authorizedresources Read

GET /{organization}/{project}/_apis/build/authorizedresources Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/authorizedresources (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_build_authorizedresources
Full name: azure-devops.azure_devops_build_authorizedresources_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type`	string	no	query parameter `type`.
`id`	string	no	query parameter `id`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_project_apis_build_authorizedresources Read

PATCH /{organization}/{project}/_apis/build/authorizedresources Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/authorizedresources (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.patch_organization_project_apis_build_authorizedresources
Full name: azure-devops.azure_devops_build_authorizedresources_authorize_project_resources

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_builds Read

Gets a list of builds. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_builds
Full name: azure-devops.azure_devops_build_builds_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definitions`	string	no	A comma-delimited list of definition IDs. If specified, filters to builds for these definitions.
`queues`	string	no	A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues.
`build_number`	string	no	If specified, filters to builds that match this build number. Append * to do a prefix search.
`min_time`	string	no	If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified.
`max_time`	string	no	If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified.
`requested_for`	string	no	If specified, filters to builds requested for the specified user.
`reason_filter`	string	no	If specified, filters to builds that match this reason.
`status_filter`	string	no	If specified, filters to builds that match this status.
`result_filter`	string	no	If specified, filters to builds that match this result.
`tag_filters`	string	no	A comma-delimited list of tags. If specified, filters to builds that have the specified tags.
`properties`	string	no	A comma-delimited list of properties to retrieve.
`top`	number	no	The maximum number of builds to return.
`continuation_token`	string	no	A continuation token, returned by a previous call to this method, that can be used to return the next set of builds.
`max_builds_per_definition`	number	no	The maximum number of builds to return per definition.
`deleted_filter`	string	no	Indicates whether to exclude, include, or only return deleted builds.
`query_order`	string	no	The order in which builds should be returned.
`branch_name`	string	no	If specified, filters to builds that built branches that built this branch.
`build_ids`	string	no	A comma-delimited list that specifies the IDs of builds to retrieve.
`repository_id`	string	no	If specified, filters to builds that built from this repository.
`repository_type`	string	no	If specified, filters to builds that built from repositories of this type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

queues_build Read

Queues a build Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/builds (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.queues_build
Full name: azure-devops.azure_devops_build_builds_queue

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`ignore_warnings`	boolean	no	query parameter `ignoreWarnings`.
`check_in_ticket`	string	no	query parameter `checkInTicket`.
`source_build_id`	number	no	query parameter `sourceBuildId`.
`definition_id`	number	no	Optional definition id to queue a build without a body. Ignored if there's a valid body
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

updates_multiple_builds Write

Updates multiple builds. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_multiple_builds
Full name: azure-devops.azure_devops_build_builds_update_builds

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The builds to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

gets_build Read

Gets a build Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_build
Full name: azure-devops.azure_devops_build_builds_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	path parameter `buildId`.
`property_filters`	string	no	query parameter `propertyFilters`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

updates_build Write

Updates a build. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_build
Full name: azure-devops.azure_devops_build_builds_update_build

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The build.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`retry`	boolean	no	query parameter `retry`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

deletes_build Read

Deletes a build. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.deletes_build
Full name: azure-devops.azure_devops_build_builds_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

gets_latest_timeline_build_filtered_specific_stage Read

Gets the latest timeline for a build filtered to a specific stage. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/Timeline/stages/{stageName} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_latest_timeline_build_filtered_specific_stage
Full name: azure-devops.azure_devops_build_stage_timeline_get_build_stage_latest_timeline

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`stage_name`	string	yes	The name of the stage to filter by.
`change_id`	number	no	The change ID to filter by.
`plan_id`	string	no	The ID of the plan.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_timeline_build_filtered_specific_stage Read

Gets the timeline for a build filtered to a specific stage. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/Timeline/{timelineId}/stages/{stageName} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_timeline_build_filtered_specific_stage
Full name: azure-devops.azure_devops_build_stage_timeline_get_build_stage_timeline

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`timeline_id`	string	yes	The ID of the timeline.
`stage_name`	string	yes	The name of the stage to filter by.
`change_id`	number	no	The change ID to filter by.
`plan_id`	string	no	The ID of the plan.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_all_artifacts_build Read

Gets all artifacts for a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/artifacts (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_all_artifacts_build
Full name: azure-devops.azure_devops_build_artifacts_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

associates_artifact_with_build Read

Associates an artifact with a build. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/artifacts (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.associates_artifact_with_build
Full name: azure-devops.azure_devops_build_artifacts_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The artifact.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

gets_list_attachments_specific_type_that_are_associated_with_build Read

Gets the list of attachments of a specific type that are associated with a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/attachments/{type} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_attachments_specific_type_that_are_associated_with_build
Full name: azure-devops.azure_devops_build_attachments_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`type`	string	yes	The type of attachment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_changes_associated_with_build Read

Gets the changes associated with a build Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/changes (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_changes_associated_with_build
Full name: azure-devops.azure_devops_build_builds_get_build_changes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	path parameter `buildId`.
`continuation_token`	string	no	query parameter `continuationToken`.
`top`	number	no	The maximum number of changes to return
`include_source_change`	boolean	no	query parameter `includeSourceChange`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_all_retention_leases_that_apply_specific_build Read

Gets all retention leases that apply to a specific build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/leases (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_all_retention_leases_that_apply_specific_build
Full name: azure-devops.azure_devops_build_builds_get_retention_leases_for_build

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_logs_build Read

Gets the logs for a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/logs (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_logs_build
Full name: azure-devops.azure_devops_build_builds_get_build_logs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_individual_log_file_build Read

Gets an individual log file for a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/logs/{logId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_individual_log_file_build
Full name: azure-devops.azure_devops_build_builds_get_build_log

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`log_id`	number	yes	The ID of the log file.
`start_line`	number	no	The start line.
`end_line`	number	no	The end line.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_properties_build Read

Gets properties for a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/properties (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_properties_build
Full name: azure-devops.azure_devops_build_properties_get_build_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`filter`	string	no	A comma-delimited list of properties. If specified, filters to these specific properties.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_properties_build Write

Updates properties for a build. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/properties (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_properties_build
Full name: azure-devops.azure_devops_build_properties_update_build_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A json-patch document describing the properties to update.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_build_report Read

Gets a build report. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/report (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_build_report
Full name: azure-devops.azure_devops_build_report_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`type`	string	no	query parameter `type`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_build_stage Read

Update a build stage Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/stages/{stageRefName} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.update_build_stage
Full name: azure-devops.azure_devops_build_stages_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`build_id`	number	yes	path parameter `buildId`.
`stage_ref_name`	string	yes	path parameter `stageRefName`.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_tags_build Read

Gets the tags for a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_tags_build
Full name: azure-devops.azure_devops_build_tags_get_build_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

adds_tags_build Write

Adds tags to a build. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_tags_build
Full name: azure-devops.azure_devops_build_tags_add_build_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The tags to add. Request body is composed directly from listed tags.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

adds_removes_tags_from_build Write

Adds/Removes tags from a build. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_removes_tags_from_build
Full name: azure-devops.azure_devops_build_tags_update_build_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The tags to add/remove.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

adds_tag_build Write

Adds a tag to a build. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags/{tag} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_tag_build
Full name: azure-devops.azure_devops_build_tags_add_build_tag

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`tag`	string	yes	The tag to add.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

removes_tag_from_build_note_this_api_will_not_work_tags_with_special_characters_remove_tags_with_special_characters_use_patch_method_instead_6_0

Write

Removes a tag from a build. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+) Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags/{tag} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.removes_tag_from_build_note_this_api_will_not_work_tags_with_special_characters_remove_tags_with_special_characters_use_patch_method_instead_6_0
Full name: azure-devops.azure_devops_build_tags_delete_build_tag

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`tag`	string	yes	The tag to remove.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_details_build Read

Gets details for a build Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/timeline/{timelineId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_details_build
Full name: azure-devops.azure_devops_build_timeline_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	path parameter `buildId`.
`timeline_id`	string	yes	path parameter `timelineId`.
`change_id`	number	no	query parameter `changeId`.
`plan_id`	string	no	query parameter `planId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_work_items_associated_with_build_only_work_items_same_project_are_returned Read

Gets the work items associated with a build. Only work items in the same project are returned. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/workitems (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_work_items_associated_with_build_only_work_items_same_project_are_returned
Full name: azure-devops.azure_devops_build_builds_get_build_work_items_refs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`top`	number	no	The maximum number of work items to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_work_items_associated_with_build_filtered_specific_commits Read

Gets the work items associated with a build, filtered to specific commits. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/workitems (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_work_items_associated_with_build_filtered_specific_commits
Full name: azure-devops.azure_devops_build_builds_get_build_work_items_refs_from_commits

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A comma-delimited list of commit IDs.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`top`	number	no	The maximum number of work items to return, or the number of commits to consider if no commit IDs are specified.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_specific_attachment Read

Gets a specific attachment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/{timelineId}/{recordId}/attachments/{type}/{name} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_specific_attachment
Full name: azure-devops.azure_devops_build_attachments_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	yes	The ID of the build.
`timeline_id`	string	yes	The ID of the timeline.
`record_id`	string	yes	The ID of the timeline record.
`type`	string	yes	The type of the attachment.
`name`	string	yes	The name of the attachment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_changes_made_repository_between_two_given_builds Read

Gets the changes made to the repository between two given builds. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/changes (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_changes_made_repository_between_two_given_builds
Full name: azure-devops.azure_devops_build_builds_get_changes_between_builds

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`from_build_id`	number	no	The ID of the first build.
`to_build_id`	number	no	The ID of the last build.
`top`	number	no	The maximum number of changes to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_list_definitions Read

Gets a list of definitions. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_definitions
Full name: azure-devops.azure_devops_build_definitions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`name`	string	no	If specified, filters to definitions whose names match this pattern.
`repository_id`	string	no	A repository ID. If specified, filters to definitions that use this repository.
`repository_type`	string	no	If specified, filters to definitions that have a repository of this type.
`query_order`	string	no	Indicates the order in which definitions should be returned.
`top`	number	no	The maximum number of definitions to return.
`continuation_token`	string	no	A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
`min_metrics_time`	string	no	If specified, indicates the date from which metrics should be included.
`definition_ids`	string	no	A comma-delimited list that specifies the IDs of definitions to retrieve.
`path`	string	no	If specified, filters to definitions under this folder.
`built_after`	string	no	If specified, filters to definitions that have builds after this date.
`not_built_after`	string	no	If specified, filters to definitions that do not have builds after this date.
`include_all_properties`	boolean	no	Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
`include_latest_builds`	boolean	no	Indicates whether to return the latest and latest completed builds for this definition.
`task_id_filter`	string	no	If specified, filters to definitions that use the specified task.
`process_type`	number	no	If specified, filters to definitions with the given process type.
`yaml_filename`	string	no	If specified, filters to YAML definitions that match the given filename. To use this filter includeAllProperties should be set to true
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

creates_new_definition Read

Creates a new definition. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/definitions (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.creates_new_definition
Full name: azure-devops.azure_devops_build_definitions_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The definition.
`project`	string	yes	Project ID or project name
`definition_to_clone_id`	number	no	query parameter `definitionToCloneId`.
`definition_to_clone_revision`	number	no	query parameter `definitionToCloneRevision`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

gets_all_definition_templates Read

Gets all definition templates. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_all_definition_templates
Full name: azure-devops.azure_devops_build_templates_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_specific_build_definition_template Read

Gets a specific build definition template. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_specific_build_definition_template
Full name: azure-devops.azure_devops_build_templates_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`template_id`	string	yes	The ID of the requested template.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

updates_existing_build_definition_template Read

Updates an existing build definition template. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_existing_build_definition_template
Full name: azure-devops.azure_devops_build_templates_save_template

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new version of the template.
`project`	string	yes	Project ID or project name
`template_id`	string	yes	The ID of the template.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

deletes_build_definition_template Read

Deletes a build definition template. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.deletes_build_definition_template
Full name: azure-devops.azure_devops_build_templates_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`template_id`	string	yes	The ID of the template.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_tags_definition Read

Gets the tags for a definition. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_tags_definition
Full name: azure-devops.azure_devops_build_tags_get_definition_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`revision`	number	no	The definition revision number. If not specified, uses the latest revision of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

adds_multiple_tags_definition Write

Adds multiple tags to a definition. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_multiple_tags_definition
Full name: azure-devops.azure_devops_build_tags_add_definition_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The tags to add.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

adds_removes_tags_from_definition Write

Adds/Removes tags from a definition. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_removes_tags_from_definition
Full name: azure-devops.azure_devops_build_tags_update_definition_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The tags to add/remove.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

adds_tag_definition Write

Adds a tag to a definition Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags/{tag} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_tag_definition
Full name: azure-devops.azure_devops_build_tags_add_definition_tag

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`tag`	string	yes	The tag to add.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

removes_tag_from_definition_note_this_api_will_not_work_tags_with_special_characters_remove_tags_with_special_characters_use_patch_method_instead_6_0

Write

Removes a tag from a definition. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+) Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags/{tag} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.removes_tag_from_definition_note_this_api_will_not_work_tags_with_special_characters_remove_tags_with_special_characters_use_patch_method_instead_6_0
Full name: azure-devops.azure_devops_build_tags_delete_definition_tag

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`tag`	string	yes	The tag to remove.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_definition_optionally_at_specific_revision Read

Gets a definition, optionally at a specific revision. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_definition_optionally_at_specific_revision
Full name: azure-devops.azure_devops_build_definitions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`revision`	number	no	The revision number to retrieve. If this is not specified, the latest version will be returned.
`min_metrics_time`	string	no	If specified, indicates the date from which metrics should be included.
`property_filters`	string	no	A comma-delimited list of properties to include in the results.
`include_latest_builds`	boolean	no	query parameter `includeLatestBuilds`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

updates_existing_build_definition_order_this_operation_succeed_value_revision_property_request_body_must_match_existing_build_definition_it_is_recommended_that_you_obtain_existing_build_definition_by_using_get_modify_build_definition_necessary_and_then_submit_modified_definition_with_put

Read

Updates an existing build definition. In order for this operation to succeed, the value of the "Revision" property of the request body must match the existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify the build definition as necessary, and then submit the modified definition with PUT. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_existing_build_definition_order_this_operation_succeed_value_revision_property_request_body_must_match_existing_build_definition_it_is_recommended_that_you_obtain_existing_build_definition_by_using_get_modify_build_definition_necessary_and_then_submit_modified_definition_with_put
Full name: azure-devops.azure_devops_build_definitions_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new version of the definition. Its "Revision" property must match the existing definition for the update to be accepted.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`secrets_source_definition_id`	number	no	Optional ID of the definition to use as the source for secrets.
`secrets_source_definition_revision`	number	no	Optional revision of the secrets source definition.
`cancel_paused_builds`	boolean	no	If true, cancels paused builds when the pipeline is being enabled from a paused or disabled state.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

restores_deleted_definition Read

Restores a deleted definition Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.restores_deleted_definition
Full name: azure-devops.azure_devops_build_definitions_restore_definition

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The identifier of the definition to restore.
`deleted`	boolean	no	When false, restores a deleted definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

deletes_definition_and_all_associated_builds Read

Deletes a definition and all associated builds. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.deletes_definition_and_all_associated_builds
Full name: azure-devops.azure_devops_build_definitions_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

gets_build_metrics_definition Read

Gets build metrics for a definition. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/metrics (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_build_metrics_definition
Full name: azure-devops.azure_devops_build_metrics_get_definition_metrics

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`min_metrics_time`	string	no	The date from which to calculate metrics.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_properties_definition Read

Gets properties for a definition. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/properties (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_properties_definition
Full name: azure-devops.azure_devops_build_properties_get_definition_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`filter`	string	no	A comma-delimited list of properties. If specified, filters to these specific properties.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_properties_definition Write

Updates properties for a definition. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/properties (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_properties_definition
Full name: azure-devops.azure_devops_build_properties_update_definition_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A json-patch document describing the properties to update.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_build_definitions_definitionid_resources Read

GET /{organization}/{project}/_apis/build/definitions/{definitionId}/resources Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/resources (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_build_definitions_definitionid_resources
Full name: azure-devops.azure_devops_build_resources_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	path parameter `definitionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_project_apis_build_definitions_definitionid_resources Read

PATCH /{organization}/{project}/_apis/build/definitions/{definitionId}/resources Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/resources (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.patch_organization_project_apis_build_definitions_definitionid_resources
Full name: azure-devops.azure_devops_build_resources_authorize_definition_resources

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	path parameter `definitionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_all_revisions_definition Read

Gets all revisions of a definition. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/revisions (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_all_revisions_definition
Full name: azure-devops.azure_devops_build_definitions_get_definition_revisions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

converts_definition_yaml_optionally_at_specific_revision Read

Converts a definition to YAML, optionally at a specific revision. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/yaml (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.converts_definition_yaml_optionally_at_specific_revision
Full name: azure-devops.azure_devops_build_yaml_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	The ID of the definition.
`revision`	number	no	The revision number to retrieve. If this is not specified, the latest version will be returned.
`min_metrics_time`	string	no	If specified, indicates the date from which metrics should be included.
`property_filters`	string	no	A comma-delimited list of properties to include in the results.
`include_latest_builds`	boolean	no	query parameter `includeLatestBuilds`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_existing_folder_at_given_existing_path Read

Updates an existing folder at given existing path Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/folders (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_existing_folder_at_given_existing_path
Full name: azure-devops.azure_devops_build_folders_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new version of the folder.
`project`	string	yes	Project ID or project name
`path`	string	no	The full path to the folder.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_new_folder Read

Creates a new folder. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/build/folders (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.creates_new_folder
Full name: azure-devops.azure_devops_build_folders_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The folder.
`project`	string	yes	Project ID or project name
`path`	string	no	The full path of the folder.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

deletes_definition_folder_definitions_and_their_corresponding_builds_will_also_be_deleted Read

Deletes a definition folder. Definitions and their corresponding builds will also be deleted. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/folders (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.deletes_definition_folder_definitions_and_their_corresponding_builds_will_also_be_deleted
Full name: azure-devops.azure_devops_build_folders_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`path`	string	no	The full path to the folder.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_list_build_definition_folders Read

Gets a list of build definition folders. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/folders/{path} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_build_definition_folders
Full name: azure-devops.azure_devops_build_folders_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`path`	string	yes	The path to start with.
`query_order`	string	no	The order in which folders should be returned.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_pipeline_general_settings Read

Gets pipeline general settings. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_pipeline_general_settings
Full name: azure-devops.azure_devops_build_general_settings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_pipeline_general_settings Read

Updates pipeline general settings. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_pipeline_general_settings
Full name: azure-devops.azure_devops_build_general_settings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_latest_build_definition_optionally_scoped_specific_branch Read

Gets the latest build for a definition, optionally scoped to a specific branch. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/latest/{definition} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_latest_build_definition_optionally_scoped_specific_branch
Full name: azure-devops.azure_devops_build_latest_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition`	string	yes	definition name with optional leading folder path, or the definition id
`branch_name`	string	no	optional parameter that indicates the specific branch to use. If not specified, the default branch is used.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_build_metrics_project Read

Gets build metrics for a project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/metrics/{metricAggregationType} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_build_metrics_project
Full name: azure-devops.azure_devops_build_metrics_get_project_metrics

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`metric_aggregation_type`	string	yes	The aggregation type to use (hourly, daily).
`min_metrics_time`	string	no	The date from which to calculate metrics.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_all_build_definition_options_supported_by_system Read

Gets all build definition options supported by the system. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/options (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_all_build_definition_options_supported_by_system
Full name: azure-devops.azure_devops_build_options_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_badge_that_indicates_status_most_recent_build_specified_branch Read

Gets a badge that indicates the status of the most recent build for the specified branch. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/repos/{repoType}/badge (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_badge_that_indicates_status_most_recent_build_specified_branch
Full name: azure-devops.azure_devops_build_badge_get_build_badge_data

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repo_type`	string	yes	The repository type.
`repo_id`	string	no	The repository ID.
`branch_name`	string	no	The branch name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_project_retention_settings Read

Gets the project's retention settings. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/retention (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_project_retention_settings
Full name: azure-devops.azure_devops_build_retention_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_project_retention_settings Read

Updates the project's retention settings. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/retention (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_project_retention_settings
Full name: azure-devops.azure_devops_build_retention_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_any_leases_matching_specified_minimalretentionleases Read

Returns any leases matching the specified MinimalRetentionLeases Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.returns_any_leases_matching_specified_minimalretentionleases
Full name: azure-devops.azure_devops_build_leases_get_retention_leases_by_minimal_retention_leases

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`leases_to_fetch`	string	no	List of JSON-serialized MinimalRetentionLeases separated by '\|'
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

adds_new_leases_pipeline_runs Read

Adds new leases for pipeline runs. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.adds_new_leases_pipeline_runs
Full name: azure-devops.azure_devops_build_leases_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_specific_retention_leases Read

Removes specific retention leases. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.removes_specific_retention_leases
Full name: azure-devops.azure_devops_build_leases_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`ids`	string	no	query parameter `ids`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_details_retention_lease_given_lease_id Read

Returns the details of the retention lease given a lease id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.returns_details_retention_lease_given_lease_id
Full name: azure-devops.azure_devops_build_leases_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`lease_id`	number	yes	path parameter `leaseId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_duration_or_pipeline_protection_status_retention_lease Read

Updates the duration or pipeline protection status of a retention lease. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_duration_or_pipeline_protection_status_retention_lease
Full name: azure-devops.azure_devops_build_leases_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new data for the retention lease.
`project`	string	yes	Project ID or project name
`lease_id`	number	yes	The ID of the lease to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_build_settings Read

Gets the build settings. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/settings (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_build_settings
Full name: azure-devops.azure_devops_build_settings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_build_settings Read

Updates the build settings. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/build/settings (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.updates_build_settings
Full name: azure-devops.azure_devops_build_settings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The new settings.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_build_status_definition_optionally_scoped_specific_branch_stage_job_and_configuration_if_there_are_more_than_one_then_it_is_required_pass_stagename_value_when_specifying_jobname_and_same_rule_then_applies_both_if_passing_configuration_parameter

Read

Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration. If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/status/{definition} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_build_status_definition_optionally_scoped_specific_branch_stage_job_and_configuration_if_there_are_more_than_one_then_it_is_required_pass_stagename_value_when_specifying_jobname_and_same_rule_then_applies_both_if_passing_configuration_parameter
Full name: azure-devops.azure_devops_build_status_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition`	string	yes	Either the definition name with optional leading folder path, or the definition id.
`branch_name`	string	no	Only consider the most recent build for this branch. If not specified, the default branch is used.
`stage_name`	string	no	Use this stage within the pipeline to render the status.
`job_name`	string	no	Use this job within a stage of the pipeline to render the status.
`configuration`	string	no	Use this job configuration to render the status
`label`	string	no	Replaces the default text on the left side of the badge.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_all_build_tags_project Read

Gets a list of all build tags in the project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/tags (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_all_build_tags_project
Full name: azure-devops.azure_devops_build_tags_get_tags

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

removes_tag_from_builds_definitions_and_from_tag_store Write

Removes a tag from builds, definitions, and from the tag store Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/build/tags/{tag} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.removes_tag_from_builds_definitions_and_from_tag_store
Full name: azure-devops.azure_devops_build_tags_delete_tag

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`tag`	string	yes	The tag to remove.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_all_work_items_between_two_builds Read

Gets all the work items between two builds. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/build/workitems (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_all_work_items_between_two_builds
Full name: azure-devops.azure_devops_build_builds_get_work_items_between_builds

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`from_build_id`	number	no	The ID of the first build.
`to_build_id`	number	no	The ID of the last build.
`top`	number	no	The maximum number of work items to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_list_branches_given_source_code_repository Read

Gets a list of branches for the given source code repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/branches (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_branches_given_source_code_repository
Full name: azure-devops.azure_devops_build_source_providers_list_branches

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`repository`	string	no	The vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
`branch_name`	string	no	If supplied, the name of the branch to check for specifically.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_contents_file_given_source_code_repository Read

Gets the contents of a file in the given source code repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/filecontents (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_contents_file_given_source_code_repository
Full name: azure-devops.azure_devops_build_source_providers_get_file_contents

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`repository`	string	no	If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
`commit_or_branch`	string	no	The identifier of the commit or branch from which a file's contents are retrieved.
`path`	string	no	The path to the file to retrieve, relative to the root of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_contents_directory_given_source_code_repository Read

Gets the contents of a directory in the given source code repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/pathcontents (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_contents_directory_given_source_code_repository
Full name: azure-devops.azure_devops_build_source_providers_get_path_contents

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`repository`	string	no	If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
`commit_or_branch`	string	no	The identifier of the commit or branch from which a file's contents are retrieved.
`path`	string	no	The path contents to list, relative to the root of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_pull_request_object_from_source_provider Read

Gets a pull request object from source provider. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/pullrequests/{pullRequestId} (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_pull_request_object_from_source_provider
Full name: azure-devops.azure_devops_build_source_providers_get_pull_request

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`pull_request_id`	string	yes	Vendor-specific id of the pull request.
`repository_id`	string	no	Vendor-specific identifier or the name of the repository that contains the pull request.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_source_code_repositories Read

Gets a list of source code repositories. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/repositories (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_source_code_repositories
Full name: azure-devops.azure_devops_build_source_providers_list_repositories

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`repository`	string	no	If specified, the vendor-specific identifier or the name of a single repository to get.
`result_set`	string	no	'top' for the repositories most relevant for the endpoint. If not set, all repositories are returned. Ignored if 'repository' is set.
`page_results`	boolean	no	If set to true, this will limit the set of results and will return a continuation token to continue the query.
`continuation_token`	string	no	When paging results, this is a continuation token, returned by a previous call to this method, that can be used to return the next set of repositories.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_webhooks_installed_given_source_code_repository Read

Gets a list of webhooks installed in the given source code repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.gets_list_webhooks_installed_given_source_code_repository
Full name: azure-devops.azure_devops_build_source_providers_list_webhooks

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`repository`	string	no	If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

recreates_webhooks_specified_triggers_given_source_code_repository Read

Recreates the webhooks for the specified triggers in the given source code repository. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.recreates_webhooks_specified_triggers_given_source_code_repository
Full name: azure-devops.azure_devops_build_source_providers_restore_webhooks

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The types of triggers to restore webhooks for.
`project`	string	yes	Project ID or project name
`provider_name`	string	yes	The name of the source provider.
`service_endpoint_id`	string	no	If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
`repository`	string	no	If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_source_providers_and_their_capabilities Read

Get a list of source providers and their capabilities. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/sourceproviders (spec: build/7.2/build.json).

Lua path: app.integrations.azure_devops.get_list_source_providers_and_their_capabilities
Full name: azure-devops.azure_devops_build_source_providers_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_processes Read

Get a list of processes. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/process/processes (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_list_processes
Full name: azure-devops.azure_devops_core_processes_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_process_by_id Read

Get a process by ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/process/processes/{processId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_process_by_id
Full name: azure-devops.azure_devops_core_processes_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	ID for a process.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_projects_organization_that_authenticated_user_has_access Read

Get all projects in the organization that the authenticated user has access to. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_all_projects_organization_that_authenticated_user_has_access
Full name: azure-devops.azure_devops_core_projects_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`state_filter`	string	no	Filter on team projects in a specific team project state (default: WellFormed).
`top`	number	no	query parameter `$top`.
`skip`	number	no	query parameter `$skip`.
`continuation_token`	number	no	Pointer that shows how many projects already been fetched.
`get_default_team_image_url`	boolean	no	query parameter `getDefaultTeamImageUrl`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

queues_project_be_created_use_getoperation_operations_operations_get_periodically_check_create_project_status Read

Queues a project to be created. Use the [GetOperation](../../operations/operations/get) to periodically check for create project status. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/projects (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.queues_project_be_created_use_getoperation_operations_operations_get_periodically_check_create_project_status
Full name: azure-devops.azure_devops_core_projects_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The project to create.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_project_with_specified_id_or_name_optionally_including_capabilities Read

Get project with the specified id or name, optionally including capabilities. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects/{projectId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_project_with_specified_id_or_name_optionally_including_capabilities
Full name: azure-devops.azure_devops_core_projects_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	path parameter `projectId`.
`include_capabilities`	boolean	no	Include capabilities (such as source control) in the team project result (default: false).
`include_history`	boolean	no	Search within renamed projects (that had such name in the past).
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

update_existing_project_name_abbreviation_description_or_restore_project Read

Update an existing project's name, abbreviation, description, or restore a project. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.update_existing_project_name_abbreviation_description_or_restore_project
Full name: azure-devops.azure_devops_core_projects_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The updates for the project. The state must be set to wellFormed to restore the project.
`project_id`	string	yes	The project id of the project to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

queues_project_be_deleted_use_getoperation_operations_operations_get_periodically_check_delete_project_status Read

Queues a project to be deleted. Use the [GetOperation](../../operations/operations/get) to periodically check for delete project status. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/projects/{projectId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.queues_project_be_deleted_use_getoperation_operations_operations_get_periodically_check_delete_project_status
Full name: azure-devops.azure_devops_core_projects_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The project id of the project to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

sets_avatar_project Read

Sets the avatar for the project. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/projects/{projectId}/avatar (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.sets_avatar_project
Full name: azure-devops.azure_devops_core_avatar_set_project_avatar

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The avatar blob data object to upload.
`project_id`	string	yes	The ID or name of the project.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_avatar_project Write

Removes the avatar for the project. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/projects/{projectId}/avatar (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.removes_avatar_project
Full name: azure-devops.azure_devops_core_avatar_remove_project_avatar

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The ID or name of the project.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_user_readable_teams_project_and_teams_user_is_member_excluded_from_readable_list Read

Gets list of user readable teams in a project and teams user is member of (excluded from readable list). Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/categorizedteams/ (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.gets_list_user_readable_teams_project_and_teams_user_is_member_excluded_from_readable_list
Full name: azure-devops.azure_devops_core_categorized_teams_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The name or ID (GUID) of the team project containing the teams to retrieve.
`expand_identity`	boolean	no	A value indicating whether or not to expand Identity information in the result WebApiTeam object.
`top`	number	no	Maximum number of teams to return.
`skip`	number	no	Number of teams to skip.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_collection_team_project_properties Read

Get a collection of team project properties. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/properties (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_collection_team_project_properties
Full name: azure-devops.azure_devops_core_projects_get_project_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The team project ID.
`keys`	string	no	A comma-delimited string of team project property names. Wildcard characters ("?" and "*") are supported. If no key is specified, all properties will be returned.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_update_and_delete_team_project_properties Read

Create, update, and delete team project properties. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}/properties (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.create_update_and_delete_team_project_properties
Full name: azure-devops.azure_devops_core_projects_set_project_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The team project ID.
`body`	object	yes	A JSON Patch document that represents an array of property operations. See RFC 6902 for more details on JSON Patch. The accepted operation verbs are Add and Remove, where Add is used for both creating and updating properties. The path consists of a forward slash and a property name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_teams Read

Get a list of teams. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_list_teams
Full name: azure-devops.azure_devops_core_teams_get_teams

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	path parameter `projectId`.
`mine`	boolean	no	If true return all the teams requesting user is member, otherwise return all the teams user has read access.
`top`	number	no	Maximum number of teams to return.
`skip`	number	no	Number of teams to skip.
`expand_identity`	boolean	no	A value indicating whether or not to expand Identity information in the result WebApiTeam object.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

create_team_team_project_possible_failure_scenarios_invalid_project_name_id_project_doesn_t_exist_404_invalid_team_name_or_description_400_team_already_exists_400_insufficient_privileges_400

Read

Create a team in a team project. Possible failure scenarios Invalid project name/ID (project doesn't exist) 404 Invalid team name or description 400 Team already exists 400 Insufficient privileges 400 Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.create_team_team_project_possible_failure_scenarios_invalid_project_name_id_project_doesn_t_exist_404_invalid_team_name_or_description_400_team_already_exists_400_insufficient_privileges_400
Full name: azure-devops.azure_devops_core_teams_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The team data used to create the team.
`project_id`	string	yes	The name or ID (GUID) of the team project in which to create the team.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_specific_team Read

Get a specific team. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_specific_team
Full name: azure-devops.azure_devops_core_teams_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The name or ID (GUID) of the team project containing the team.
`team_id`	string	yes	The name or ID (GUID) of the team.
`expand_identity`	boolean	no	A value indicating whether or not to expand Identity information in the result WebApiTeam object.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_team_name_and_or_description Read

Update a team's name and/or description. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.update_team_name_and_or_description
Full name: azure-devops.azure_devops_core_teams_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project_id`	string	yes	The name or ID (GUID) of the team project containing the team to update.
`team_id`	string	yes	The name of ID of the team to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

delete_team Read

Delete a team. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId} (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.delete_team
Full name: azure-devops.azure_devops_core_teams_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The name or ID (GUID) of the team project containing the team to delete.
`team_id`	string	yes	The name or ID of the team to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_list_members_specific_team Read

Get a list of members for a specific team. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}/members (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_list_members_specific_team
Full name: azure-devops.azure_devops_core_teams_get_team_members_with_extended_properties

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project_id`	string	yes	The name or ID (GUID) of the team project the team belongs to.
`team_id`	string	yes	The name or ID (GUID) of the team .
`top`	number	no	query parameter `$top`.
`skip`	number	no	query parameter `$skip`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_all_teams Read

Get a list of all teams. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/teams (spec: core/7.2/core.json).

Lua path: app.integrations.azure_devops.get_list_all_teams
Full name: azure-devops.azure_devops_core_teams_get_all_teams

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`mine`	boolean	no	If true, then return all teams requesting user is member. Otherwise return all teams user has read access.
`top`	number	no	Maximum number of teams to return.
`skip`	number	no	Number of teams to skip.
`expand_identity`	boolean	no	A value indicating whether or not to expand Identity information in the result WebApiTeam object.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_all_available_widget_metadata_alphabetical_order_including_widgets_marked_with_isvisiblefromcatalog_false Read

Get all available widget metadata in alphabetical order, including widgets marked with isVisibleFromCatalog == false. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/dashboard/widgettypes (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.get_all_available_widget_metadata_alphabetical_order_including_widgets_marked_with_isvisiblefromcatalog_false
Full name: azure-devops.azure_devops_dashboard_widget_types_get_widget_types

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`scope`	string	no	query parameter `$scope`.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_widget_metadata_satisfying_specified_contribution_id Read

Get the widget metadata satisfying the specified contribution ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/dashboard/widgettypes/{contributionId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.get_widget_metadata_satisfying_specified_contribution_id
Full name: azure-devops.azure_devops_dashboard_widget_types_get_widget_metadata

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`contribution_id`	string	yes	The ID of Contribution for the Widget
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_dashboards_under_project Read

Get a list of dashboards under a project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.get_list_dashboards_under_project
Full name: azure-devops.azure_devops_dashboard_dashboards_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

create_supplied_dashboard Read

Create the supplied dashboard. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.create_supplied_dashboard
Full name: azure-devops.azure_devops_dashboard_dashboards_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The initial state of the dashboard
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_name_and_position_dashboards_supplied_group_and_remove_omitted_dashboards_does_not_modify_dashboard_content Read

Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.update_name_and_position_dashboards_supplied_group_and_remove_omitted_dashboards_does_not_modify_dashboard_content
Full name: azure-devops.azure_devops_dashboard_dashboards_replace_dashboards

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_dashboard_by_its_id Read

Get a dashboard by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.get_dashboard_by_its_id
Full name: azure-devops.azure_devops_dashboard_dashboards_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	path parameter `dashboardId`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

replace_configuration_specified_dashboard_replaces_widget_list_dashboard_only_if_property_is_supplied Read

Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.replace_configuration_specified_dashboard_replaces_widget_list_dashboard_only_if_property_is_supplied
Full name: azure-devops.azure_devops_dashboard_dashboards_replace_dashboard

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The Configuration of the dashboard to replace.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard to replace.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

delete_dashboard_given_its_id_this_also_deletes_widgets_associated_with_this_dashboard Read

Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.delete_dashboard_given_its_id_this_also_deletes_widgets_associated_with_this_dashboard
Full name: azure-devops.azure_devops_dashboard_dashboards_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard to delete.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_widgets_contained_specified_dashboard Read

Get widgets contained on the specified dashboard. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.get_widgets_contained_specified_dashboard
Full name: azure-devops.azure_devops_dashboard_widgets_get_widgets

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard to read.
`team`	string	yes	Team ID or team name
`e_tag`	string	no	Dashboard Widgets Version
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_widget_specified_dashboard Read

Create a widget on the specified dashboard. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.create_widget_specified_dashboard
Full name: azure-devops.azure_devops_dashboard_widgets_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	State of the widget to add
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of dashboard the widget will be added to.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

replace_widgets_specified_dashboard_with_supplied_widgets Read

Replace the widgets on specified dashboard with the supplied widgets. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.replace_widgets_specified_dashboard_with_supplied_widgets
Full name: azure-devops.azure_devops_dashboard_widgets_replace_widgets

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Revised state of widgets to store for the dashboard.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the Dashboard to modify.
`team`	string	yes	Team ID or team name
`e_tag`	string	no	Dashboard Widgets Version
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_supplied_widgets_dashboard_using_supplied_state_state_existing_widgets_not_passed_widget_list_is_preserved Write

Update the supplied widgets on the dashboard using supplied state. State of existing Widgets not passed in the widget list is preserved. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.update_supplied_widgets_dashboard_using_supplied_state_state_existing_widgets_not_passed_widget_list_is_preserved
Full name: azure-devops.azure_devops_dashboard_widgets_update_widgets

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The set of widget states to update on the dashboard.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the Dashboard to modify.
`team`	string	yes	Team ID or team name
`e_tag`	string	no	Dashboard Widgets Version
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_current_state_specified_widget Read

Get the current state of the specified widget. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.get_current_state_specified_widget
Full name: azure-devops.azure_devops_dashboard_widgets_get_widget

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard containing the widget.
`widget_id`	string	yes	ID of the widget to read.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

override_state_specified_widget Read

Override the state of the specified widget. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.override_state_specified_widget
Full name: azure-devops.azure_devops_dashboard_widgets_replace_widget

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	State to be written for the widget.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard containing the widget.
`widget_id`	string	yes	ID of the widget to update.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

perform_partial_update_specified_widget Write

Perform a partial update of the specified widget. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.perform_partial_update_specified_widget
Full name: azure-devops.azure_devops_dashboard_widgets_update_widget

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Description of the widget changes to apply. All non-null fields will be replaced.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard containing the widget.
`widget_id`	string	yes	ID of the widget to update.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_specified_widget Read

Delete the specified widget. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId} (spec: dashboard/7.2/dashboard.json).

Lua path: app.integrations.azure_devops.delete_specified_widget
Full name: azure-devops.azure_devops_dashboard_widgets_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`dashboard_id`	string	yes	ID of the dashboard containing the widget.
`widget_id`	string	yes	ID of the widget to update.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_alternative_secret_ado_oauth_app_registration Read

Create Alternative Secret for the ADO OAuth App Registration Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/_apis/delegatedauth/registrationsecret/{registrationId} (spec: delegatedAuth/7.2/delegatedAuthorization.json).

Lua path: app.integrations.azure_devops.create_alternative_secret_ado_oauth_app_registration
Full name: azure-devops.azure_devops_delegated_auth_registration_secret_create

Parameter	Type	Required	Description
`registration_id`	string	yes	The registration id of the ADO OAuth App Registration
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

rotate_one_two_secrets_ado_oauth_app_registration Read

Rotate one of the two secrets for the ADO OAuth App Registration Official Azure DevOps REST API 7.2 endpoint: PUT https://vssps.dev.azure.com/_apis/delegatedauth/registrationsecret/{registrationId} (spec: delegatedAuth/7.2/delegatedAuthorization.json).

Lua path: app.integrations.azure_devops.rotate_one_two_secrets_ado_oauth_app_registration
Full name: azure-devops.azure_devops_delegated_auth_registration_secret_rotate_secret

Parameter	Type	Required	Description
`registration_id`	string	yes	The registration id of the ADO OAuth App Registration
`secret_type`	string	no	The secret type to rotate, either primary or alternative
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

get_list_all_elastic_pools Read

Get a list of all Elastic Pools. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.get_list_all_elastic_pools
Full name: azure-devops.azure_devops_distributed_task_elasticpools_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_elastic_pool_this_will_create_new_taskagentpool_at_organization_level_if_project_id_is_provided_this_will_create_new_taskagentqueue_specified_project

Read

Create a new elastic pool. This will create a new TaskAgentPool at the organization level. If a project id is provided, this will create a new TaskAgentQueue in the specified project. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.create_new_elastic_pool_this_will_create_new_taskagentpool_at_organization_level_if_project_id_is_provided_this_will_create_new_taskagentqueue_specified_project
Full name: azure-devops.azure_devops_distributed_task_elasticpools_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Elastic pool to create. Contains the properties necessary for configuring a new ElasticPool.
`pool_name`	string	no	Name to use for the new TaskAgentPool
`authorize_all_pipelines`	boolean	no	Setting to determine if all pipelines are authorized to use this TaskAgentPool by default.
`auto_provision_project_pools`	boolean	no	Setting to automatically provision TaskAgentQueues in every project for the new pool.
`project_id`	string	no	Optional: If provided, a new TaskAgentQueue will be created in the specified project.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_elastic_pool_with_specified_pool_id Read

Returns the Elastic Pool with the specified Pool Id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools/{poolId} (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.returns_elastic_pool_with_specified_pool_id
Full name: azure-devops.azure_devops_distributed_task_elasticpools_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	Pool Id of the associated TaskAgentPool
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_settings_specified_elastic_pool Read

Update settings on a specified Elastic Pool. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools/{poolId} (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.update_settings_specified_elastic_pool
Full name: azure-devops.azure_devops_distributed_task_elasticpools_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	New Elastic Pool settings data
`pool_id`	number	yes	path parameter `poolId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_elastic_pool_diagnostics_logs_specified_elastic_pool Read

Get elastic pool diagnostics logs for a specified Elastic Pool. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools/{poolId}/logs (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.get_elastic_pool_diagnostics_logs_specified_elastic_pool
Full name: azure-devops.azure_devops_distributed_task_elasticpoollogs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	Pool Id of the Elastic Pool
`top`	number	no	Number of elastic pool logs to retrieve
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_elasticnodes_currently_elasticpool Read

Get a list of ElasticNodes currently in the ElasticPool Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools/{poolId}/nodes (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.get_list_elasticnodes_currently_elasticpool
Full name: azure-devops.azure_devops_distributed_task_nodes_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	Pool id of the ElasticPool
`state`	string	no	Optional: Filter to only retrieve ElasticNodes in the given ElasticNodeState
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_properties_specified_elasticnode Read

Update properties on a specified ElasticNode Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools/{poolId}/nodes/{elasticNodeId} (spec: distributedTask/7.2/elastic.json).

Lua path: app.integrations.azure_devops.update_properties_specified_elasticnode
Full name: azure-devops.azure_devops_distributed_task_nodes_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`pool_id`	number	yes	path parameter `poolId`.
`elastic_node_id`	number	yes	path parameter `elasticNodeId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

triggers_pipeline_run_pipelines_which_have_webhook_resource_defined_with_specified_webhook_name_property_webhook_service_connection

Read

Triggers a pipeline run of pipelines which have a webhook resource defined with specified WebHook Name property of the WebHook service connection. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/public/distributedtask/webhooks/{webHookId} (spec: distributedTask/7.2/task.json).

Lua path: app.integrations.azure_devops.triggers_pipeline_run_pipelines_which_have_webhook_resource_defined_with_specified_webhook_name_property_webhook_service_connection
Full name: azure-devops.azure_devops_distributed_task_webhooks_receive_external_event

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`web_hook_id`	string	yes	The WebHook Name property of the WebHook service connection
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

send_pipeline_job_event_be_processed_by_execution_plan Read

Send a pipeline job event to be processed by the execution plan. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/events (spec: distributedTask/7.2/task.json).

Lua path: app.integrations.azure_devops.send_pipeline_job_event_be_processed_by_execution_plan
Full name: azure-devops.azure_devops_distributed_task_events_post_event

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The event data to be processed by the plan.
`scope_identifier`	string	yes	The project GUID to scope the request
`hub_name`	string	yes	The name of the server hub. Common examples: "build", "rm", "checks"
`plan_id`	string	yes	The ID of the plan.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_scopeidentifier_apis_distributedtask_hubs_hubname_plans_planid_jobs_jobid_oidctoken Read

POST /{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/jobs/{jobId}/oidctoken Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/jobs/{jobId}/oidctoken (spec: distributedTask/7.2/task.json).

Lua path: app.integrations.azure_devops.post_organization_scopeidentifier_apis_distributedtask_hubs_hubname_plans_planid_jobs_jobid_oidctoken
Full name: azure-devops.azure_devops_distributed_task_oidctoken_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`scope_identifier`	string	yes	The project GUID to scope the request
`hub_name`	string	yes	The name of the server hub. Common examples: "build", "rm", "checks"
`plan_id`	string	yes	path parameter `planId`.
`job_id`	string	yes	path parameter `jobId`.
`service_connection_id`	string	no	query parameter `serviceConnectionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_log_and_connect_it_pipeline_run_execution_plan Read

Create a log and connect it to a pipeline run's execution plan. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/logs (spec: distributedTask/7.2/task.json).

Lua path: app.integrations.azure_devops.create_log_and_connect_it_pipeline_run_execution_plan
Full name: azure-devops.azure_devops_distributed_task_logs_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	An object that contains information about log's path.
`scope_identifier`	string	yes	The project GUID to scope the request
`hub_name`	string	yes	The name of the server hub. Common examples: "build", "rm", "checks"
`plan_id`	string	yes	The ID of the plan.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

append_log_task_log_log_should_be_sent_body_request_tasklog_object_stream Read

Append a log to a task's log. The log should be sent in the body of the request as a TaskLog object stream. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/logs/{logId} (spec: distributedTask/7.2/task.json).

Lua path: app.integrations.azure_devops.append_log_task_log_log_should_be_sent_body_request_tasklog_object_stream
Full name: azure-devops.azure_devops_distributed_task_logs_append_log_content

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Raw payload: provide `content` as a string and optional `content_type`.
`scope_identifier`	string	yes	The project GUID to scope the request
`hub_name`	string	yes	The name of the server hub. Common examples: "build", "rm", "checks"
`plan_id`	string	yes	The ID of the plan.
`log_id`	number	yes	The ID of the log.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_timeline_records_if_they_already_exist_otherwise_create_new_ones_same_timeline Read

Update timeline records if they already exist, otherwise create new ones for the same timeline. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/timelines/{timelineId}/records (spec: distributedTask/7.2/task.json).

Lua path: app.integrations.azure_devops.update_timeline_records_if_they_already_exist_otherwise_create_new_ones_same_timeline
Full name: azure-devops.azure_devops_distributed_task_records_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The array of timeline records to be updated.
`scope_identifier`	string	yes	The project GUID to scope the request
`hub_name`	string	yes	The name of the server hub. Common examples: "build", "rm", "checks"
`plan_id`	string	yes	The ID of the plan.
`timeline_id`	string	yes	The ID of the timeline.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_apis_distributedtask_agentclouds Read

GET /{organization}/_apis/distributedtask/agentclouds Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/agentclouds (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_organization_apis_distributedtask_agentclouds
Full name: azure-devops.azure_devops_distributed_task_agentclouds_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_apis_distributedtask_agentclouds Read

POST /{organization}/_apis/distributedtask/agentclouds Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/distributedtask/agentclouds (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.post_organization_apis_distributedtask_agentclouds
Full name: azure-devops.azure_devops_distributed_task_agentclouds_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_distributedtask_agentclouds_agentcloudid Read

GET /{organization}/_apis/distributedtask/agentclouds/{agentCloudId} Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/agentclouds/{agentCloudId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_organization_apis_distributedtask_agentclouds_agentcloudid
Full name: azure-devops.azure_devops_distributed_task_agentclouds_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`agent_cloud_id`	number	yes	path parameter `agentCloudId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_apis_distributedtask_agentclouds_agentcloudid Read

PATCH /{organization}/_apis/distributedtask/agentclouds/{agentCloudId} Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/distributedtask/agentclouds/{agentCloudId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.patch_organization_apis_distributedtask_agentclouds_agentcloudid
Full name: azure-devops.azure_devops_distributed_task_agentclouds_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`agent_cloud_id`	number	yes	path parameter `agentCloudId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_apis_distributedtask_agentclouds_agentcloudid Read

DELETE /{organization}/_apis/distributedtask/agentclouds/{agentCloudId} Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/distributedtask/agentclouds/{agentCloudId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_organization_apis_distributedtask_agentclouds_agentcloudid
Full name: azure-devops.azure_devops_distributed_task_agentclouds_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`agent_cloud_id`	number	yes	path parameter `agentCloudId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_distributedtask_agentclouds_agentcloudid_requests Read

GET /{organization}/_apis/distributedtask/agentclouds/{agentCloudId}/requests Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/agentclouds/{agentCloudId}/requests (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_organization_apis_distributedtask_agentclouds_agentcloudid_requests
Full name: azure-devops.azure_devops_distributed_task_requests_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`agent_cloud_id`	number	yes	path parameter `agentCloudId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_agent_cloud_types Read

Get agent cloud types. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/agentcloudtypes (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_agent_cloud_types
Full name: azure-devops.azure_devops_distributed_task_agentcloudtypes_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_agent_pools Read

Get a list of agent pools. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/pools (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_list_agent_pools
Full name: azure-devops.azure_devops_distributed_task_pools_get_agent_pools_by_ids

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_ids`	string	no	pool Ids to fetch
`action_filter`	string	no	Filter by whether the calling user has use or manage permissions
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_agent_pool Read

Create an agent pool. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/distributedtask/pools (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.create_agent_pool
Full name: azure-devops.azure_devops_distributed_task_pools_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Details about the new agent pool
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_agent_pool Read

Get information about an agent pool. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_information_about_agent_pool
Full name: azure-devops.azure_devops_distributed_task_pools_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	An agent pool ID
`properties`	string	no	Agent pool properties (comma-separated)
`action_filter`	string	no	Filter by whether the calling user has use or manage permissions
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_properties_agent_pool Read

Update properties on an agent pool Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_properties_agent_pool
Full name: azure-devops.azure_devops_distributed_task_pools_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated agent pool details
`pool_id`	number	yes	The agent pool to update
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_agent_pool Read

Delete an agent pool. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_agent_pool
Full name: azure-devops.azure_devops_distributed_task_pools_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	ID of the agent pool to delete
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_agents Read

Get a list of agents. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_list_agents
Full name: azure-devops.azure_devops_distributed_task_agents_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	The agent pool containing the agents
`agent_name`	string	no	Filter on agent name
`include_capabilities`	boolean	no	Whether to include the agents' capabilities in the response
`include_assigned_request`	boolean	no	Whether to include details about the agents' current work
`include_last_completed_request`	boolean	no	Whether to include details about the agents' most recent completed work
`property_filters`	string	no	Filter which custom properties will be returned
`demands`	string	no	Filter by demands the agents can satisfy
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

adds_agent_pool_you_probably_don_t_want_call_this_endpoint_directly_instead_configure_agent_https_docs_microsoft_com_pipelines_agents_agents_using_agent_download_package

Read

Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, [configure an agent](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) using the agent download package. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.adds_agent_pool_you_probably_don_t_want_call_this_endpoint_directly_instead_configure_agent_https_docs_microsoft_com_pipelines_agents_agents_using_agent_download_package
Full name: azure-devops.azure_devops_distributed_task_agents_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Details about the agent being added
`pool_id`	number	yes	The agent pool in which to add the agent
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_agent Read

Get information about an agent. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_information_about_agent
Full name: azure-devops.azure_devops_distributed_task_agents_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	The agent pool containing the agent
`agent_id`	number	yes	The agent ID to get information about
`include_capabilities`	boolean	no	Whether to include the agent's capabilities in the response
`include_assigned_request`	boolean	no	Whether to include details about the agent's current work
`include_last_completed_request`	boolean	no	Whether to include details about the agents' most recent completed work
`property_filters`	string	no	Filter which custom properties will be returned
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

replace_agent_you_probably_don_t_want_call_this_endpoint_directly_instead_use_agent_configuration_script_https_docs_microsoft_com_pipelines_agents_agents_remove_and_reconfigure_agent_from_your_organization

Read

Replace an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove and reconfigure an agent from your organization. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.replace_agent_you_probably_don_t_want_call_this_endpoint_directly_instead_use_agent_configuration_script_https_docs_microsoft_com_pipelines_agents_agents_remove_and_reconfigure_agent_from_your_organization
Full name: azure-devops.azure_devops_distributed_task_agents_replace_agent

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated details about the replacing agent
`pool_id`	number	yes	The agent pool to use
`agent_id`	number	yes	The agent to replace
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_agent_details Read

Update agent details. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_agent_details
Full name: azure-devops.azure_devops_distributed_task_agents_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated details about the agent
`pool_id`	number	yes	The agent pool to use
`agent_id`	number	yes	The agent to update
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_agent_you_probably_don_t_want_call_this_endpoint_directly_instead_use_agent_configuration_script_https_docs_microsoft_com_pipelines_agents_agents_remove_agent_from_your_organization

Read

Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_agent_you_probably_don_t_want_call_this_endpoint_directly_instead_use_agent_configuration_script_https_docs_microsoft_com_pipelines_agents_agents_remove_agent_from_your_organization
Full name: azure-devops.azure_devops_distributed_task_agents_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	The pool ID to remove the agent from
`agent_id`	number	yes	The agent ID to remove
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

checks_if_current_identity_has_passed_permissions_pool Read

Checks if current identity has passed permissions on a pool. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/permissions/{permissions} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.checks_if_current_identity_has_passed_permissions_pool
Full name: azure-devops.azure_devops_distributed_task_poolpermissions_has_pool_permissions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_id`	number	yes	Id of the pool to check
`permissions`	number	yes	Permissions to check. Multiple permissions might be merged into single value using bitwise OR operator (e.g. AgentPoolPermissions.Manage \| AgentPoolPermissions.View)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_variable_group Read

Add a variable group. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/distributedtask/variablegroups (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.add_variable_group
Full name: azure-devops.azure_devops_distributed_task_variablegroups_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

add_variable_group Read

Add a variable group. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/distributedtask/variablegroups (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.add_variable_group
Full name: azure-devops.azure_devops_distributed_task_variablegroups_share_variable_group

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`variable_group_id`	number	no	query parameter `variableGroupId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_variable_group Read

Update a variable group. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/distributedtask/variablegroups/{groupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_variable_group
Full name: azure-devops.azure_devops_distributed_task_variablegroups_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`group_id`	number	yes	Id of the variable group to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_variable_group Read

Delete a variable group Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/distributedtask/variablegroups/{groupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_variable_group
Full name: azure-devops.azure_devops_distributed_task_variablegroups_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_id`	number	yes	Id of the variable group.
`project_ids`	string	no	query parameter `projectIds`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_yaml_schema_used_yaml_file_validation Read

GET the Yaml schema used for Yaml file validation. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/distributedtask/yamlschema (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_yaml_schema_used_yaml_file_validation
Full name: azure-devops.azure_devops_distributed_task_yamlschema_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`validate_task_names`	boolean	no	Whether the schema should validate that tasks are actually installed (useful for offline tools where you don't want validation).
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_deployment_groups_by_name_or_ids Read

Get a list of deployment groups by name or IDs. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_list_deployment_groups_by_name_or_ids
Full name: azure-devops.azure_devops_distributed_task_deploymentgroups_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`name`	string	no	Name of the deployment group.
`action_filter`	string	no	Get only deployment groups on which this action can be performed.
`expand`	string	no	Include these additional details in the returned objects.
`continuation_token`	string	no	Get deployment groups with names greater than this continuationToken lexicographically.
`top`	number	no	Maximum number of deployment groups to return. Default is 1000.
`ids`	string	no	Comma separated list of IDs of the deployment groups.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_deployment_group Read

Create a deployment group. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.create_deployment_group
Full name: azure-devops.azure_devops_distributed_task_deploymentgroups_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Deployment group to create.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_deployment_group_by_its_id Read

Get a deployment group by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_deployment_group_by_its_id
Full name: azure-devops.azure_devops_distributed_task_deploymentgroups_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group.
`action_filter`	string	no	Get the deployment group only if this action can be performed on it.
`expand`	string	no	Include these additional details in the returned object.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_deployment_group Read

Update a deployment group. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_deployment_group
Full name: azure-devops.azure_devops_distributed_task_deploymentgroups_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Deployment group to update.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_deployment_group Read

Delete a deployment group. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_deployment_group
Full name: azure-devops.azure_devops_distributed_task_deploymentgroups_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group to be deleted.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_deployment_targets_deployment_group Read

Get a list of deployment targets in a deployment group. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_list_deployment_targets_deployment_group
Full name: azure-devops.azure_devops_distributed_task_targets_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group.
`tags`	string	no	Get only the deployment targets that contain all these comma separted list of tags.
`name`	string	no	Name pattern of the deployment targets to return.
`partial_name_match`	boolean	no	When set to true, treats name as pattern. Else treats it as absolute match. Default is false.
`expand`	string	no	Include these additional details in the returned objects.
`agent_status`	string	no	Get only deployment targets that have this status.
`agent_job_result`	string	no	Get only deployment targets that have this last job result.
`continuation_token`	string	no	Get deployment targets with names greater than this continuationToken lexicographically.
`top`	number	no	Maximum number of deployment targets to return. Default is 1000.
`enabled`	boolean	no	Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.
`property_filters`	string	no	query parameter `propertyFilters`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_tags_list_deployment_targets_deployment_group Read

Update tags of a list of deployment targets in a deployment group. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_tags_list_deployment_targets_deployment_group
Full name: azure-devops.azure_devops_distributed_task_targets_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Deployment targets with tags to udpdate.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group in which deployment targets are updated.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_deployment_target_by_its_id_deployment_group Read

Get a deployment target by its ID in a deployment group Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_deployment_target_by_its_id_deployment_group
Full name: azure-devops.azure_devops_distributed_task_targets_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group to which deployment target belongs.
`target_id`	number	yes	ID of the deployment target to return.
`expand`	string	no	Include these additional details in the returned objects.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_deployment_target_deployment_group_this_deletes_agent_from_associated_deployment_pool_too Read

Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_deployment_target_deployment_group_this_deletes_agent_from_associated_deployment_pool_too
Full name: azure-devops.azure_devops_distributed_task_targets_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`deployment_group_id`	number	yes	ID of the deployment group in which deployment target is deleted.
`target_id`	number	yes	ID of the deployment target to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_agent_queues_by_pool_ids Read

Get a list of agent queues by pool ids Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_list_agent_queues_by_pool_ids
Full name: azure-devops.azure_devops_distributed_task_queues_get_agent_queues_for_pools

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pool_ids`	string	no	A comma-separated list of pool ids to get the corresponding queues for
`project`	string	yes	Project ID or project name
`action_filter`	string	no	Filter by whether the calling user has use or manage permissions
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_agent_queue_connect_project_agent_pool Read

Create a new agent queue to connect a project to an agent pool. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.create_new_agent_queue_connect_project_agent_pool
Full name: azure-devops.azure_devops_distributed_task_queues_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Details about the queue to create
`project`	string	yes	Project ID or project name
`authorize_pipelines`	boolean	no	Automatically authorize this queue when using YAML
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_about_agent_queue Read

Get information about an agent queue. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues/{queueId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_information_about_agent_queue
Full name: azure-devops.azure_devops_distributed_task_queues_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`queue_id`	number	yes	The agent queue to get information about
`project`	string	yes	Project ID or project name
`action_filter`	string	no	Filter by whether the calling user has use or manage permissions
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_agent_queue_from_project Read

Removes an agent queue from a project. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues/{queueId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.removes_agent_queue_from_project
Full name: azure-devops.azure_devops_distributed_task_queues_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`queue_id`	number	yes	The agent queue to remove
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_secure_files Read

Get secure files Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/securefiles (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_secure_files
Full name: azure-devops.azure_devops_distributed_task_securefiles_get_secure_files_by_names

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`secure_file_names`	string	no	A list of secure file Ids
`include_download_tickets`	boolean	no	If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
`action_filter`	string	no	query parameter `actionFilter`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_secure_files_using_name_pattern_and_condition_file_properties Read

Query secure files using a name pattern and a condition on file properties. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/securefiles (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.query_secure_files_using_name_pattern_and_condition_file_properties
Full name: azure-devops.azure_devops_distributed_task_securefiles_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The main condition syntax is described [here](https://go.microsoft.com/fwlink/?linkid=842996). Use the property('property-name') function to access the value of the specified property of a secure file. It returns null if the property is not set. E.g. ``` and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) ) ```
`project`	string	yes	Project ID or project name
`name_pattern`	string	no	Name of the secure file to match. Can include wildcards to match multiple files.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_properties_and_or_names_set_secure_files_files_are_identified_by_their_ids_properties_provided_override_existing_one_entirely_i_do_not_merge

Write

Update properties and/or names of a set of secure files. Files are identified by their IDs. Properties provided override the existing one entirely, i.e. do not merge. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/securefiles (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_properties_and_or_names_set_secure_files_files_are_identified_by_their_ids_properties_provided_override_existing_one_entirely_i_do_not_merge
Full name: azure-devops.azure_devops_distributed_task_securefiles_update_secure_files

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A list of secure file objects. Only three field must be populated Id, Name, and Properties. The rest of fields in the object are ignored.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_secure_file Read

Get a secure file Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/securefiles/{secureFileId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_secure_file
Full name: azure-devops.azure_devops_distributed_task_securefiles_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`secure_file_id`	string	yes	The unique secure file Id
`include_download_ticket`	boolean	no	If includeDownloadTicket is true and the caller has permissions, a download ticket is included in the response.
`action_filter`	string	no	query parameter `actionFilter`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_name_or_properties_existing_secure_file Write

Update the name or properties of an existing secure file Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/securefiles/{secureFileId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_name_or_properties_existing_secure_file
Full name: azure-devops.azure_devops_distributed_task_securefiles_update_secure_file

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The secure file with updated name and/or properties
`project`	string	yes	Project ID or project name
`secure_file_id`	string	yes	The unique secure file Id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_secure_file Read

Delete a secure file Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/distributedtask/securefiles/{secureFileId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_secure_file
Full name: azure-devops.azure_devops_distributed_task_securefiles_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`secure_file_id`	string	yes	The unique secure file Id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_task_group Read

Create a task group. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/taskgroups (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.create_task_group
Full name: azure-devops.azure_devops_distributed_task_taskgroups_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Task group object to create.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

list_task_groups Read

List task groups. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/taskgroups/{taskGroupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.list_task_groups
Full name: azure-devops.azure_devops_distributed_task_taskgroups_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`task_group_id`	string	yes	Id of the task group.
`expanded`	boolean	no	'true' to recursively expand task groups. Default is 'false'.
`task_id_filter`	string	no	Guid of the taskId to filter.
`deleted`	boolean	no	'true'to include deleted task groups. Default is 'false'.
`top`	number	no	Number of task groups to get.
`continuation_token`	string	no	Gets the task groups after the continuation token provided.
`query_order`	string	no	Gets the results in the defined order. Default is 'CreatedOnDescending'.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_task_group Read

Update a task group. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/distributedtask/taskgroups/{taskGroupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.update_task_group
Full name: azure-devops.azure_devops_distributed_task_taskgroups_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Task group to update.
`project`	string	yes	Project ID or project name
`task_group_id`	string	yes	Id of the task group to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_task_group Read

Delete a task group. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/distributedtask/taskgroups/{taskGroupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.delete_task_group
Full name: azure-devops.azure_devops_distributed_task_taskgroups_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`task_group_id`	string	yes	Id of the task group to be deleted.
`comment`	string	no	Comments to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_variable_groups_by_ids Read

Get variable groups by ids. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/variablegroups (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_variable_groups_by_ids
Full name: azure-devops.azure_devops_distributed_task_variablegroups_get_variable_groups_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`group_ids`	string	no	Comma separated list of Ids of variable groups.
`load_secrets`	boolean	no	Flag indicating if the secrets within variable groups should be loaded.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_variable_group Read

Get a variable group. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/variablegroups/{groupId} (spec: distributedTask/7.2/taskAgent.json).

Lua path: app.integrations.azure_devops.get_variable_group
Full name: azure-devops.azure_devops_distributed_task_variablegroups_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`group_id`	number	yes	Id of the variable group.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_all_environments Read

Get all environments. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_all_environments
Full name: azure-devops.azure_devops_environments_environments_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`name`	string	no	query parameter `name`.
`continuation_token`	string	no	query parameter `continuationToken`.
`top`	number	no	query parameter `$top`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_environment Read

Create an environment. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.create_environment
Full name: azure-devops.azure_devops_environments_environments_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Environment to create.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_pat_token_creating_and_deleting_deployment_targets_environment Read

GET a PAT token for creating and deleting deployment targets in an environment. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/environmentaccesstoken/{environmentId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_pat_token_creating_and_deleting_deployment_targets_environment
Full name: azure-devops.azure_devops_environments_environmentaccesstoken_generate_environment_access_token

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	ID of the environment in which deployment targets are managed.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

get_environment_by_its_id Read

Get an environment by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_environment_by_its_id
Full name: azure-devops.azure_devops_environments_environments_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	ID of the environment.
`expands`	string	no	Include these additional details in the returned objects.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_specified_environment Read

Update the specified environment. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.update_specified_environment
Full name: azure-devops.azure_devops_environments_environments_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Environment data to update.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	ID of the environment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_specified_environment Read

Delete the specified environment. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.delete_specified_environment
Full name: azure-devops.azure_devops_environments_environments_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	ID of the environment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_environment_deployment_execution_history Read

Get environment deployment execution history Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/environmentdeploymentrecords (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_environment_deployment_execution_history
Full name: azure-devops.azure_devops_environments_environmentdeploymentrecords_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	path parameter `environmentId`.
`continuation_token`	string	no	query parameter `continuationToken`.
`top`	number	no	query parameter `top`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes Read

POST /{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes
Full name: azure-devops.azure_devops_environments_kubernetes_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	path parameter `environmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

patch_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes Read

PATCH /{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.patch_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes
Full name: azure-devops.azure_devops_environments_kubernetes_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	path parameter `environmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes_resourceid Read

GET /{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes/{resourceId} Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes/{resourceId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes_resourceid
Full name: azure-devops.azure_devops_environments_kubernetes_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	path parameter `environmentId`.
`resource_id`	number	yes	path parameter `resourceId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes_resourceid Read

DELETE /{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes/{resourceId} Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes/{resourceId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.delete_organization_project_apis_pipelines_environments_environmentid_providers_kubernetes_resourceid
Full name: azure-devops.azure_devops_environments_kubernetes_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	path parameter `environmentId`.
`resource_id`	number	yes	path parameter `resourceId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_virtual_machine_resources Read

Get Virtual Machine Resources Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_virtual_machine_resources
Full name: azure-devops.azure_devops_environments_vmresource_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	Id of the Environment
`name`	string	no	Name of the Virtual Machine Resource
`tags`	string	no	Tags of the Virtual Machine Resource
`continuation_token`	string	no	Gets the Virtual Machine Resources after the continuation token provided.
`top`	number	no	Number of Virtual Machine Resources to get. Default is 1000.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_virtual_machine_resource Read

Add Virtual Machine Resource Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.add_virtual_machine_resource
Full name: azure-devops.azure_devops_environments_vmresource_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Properties to create Virtual Machine Resource
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	Id of the Environment
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

replace_virtual_machine_resource Read

Replace Virtual Machine Resource Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.replace_virtual_machine_resource
Full name: azure-devops.azure_devops_environments_vmresource_replace_virtual_machine_resource

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Properties to replace Virtual Machine Resource
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	Id of the Environment
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_virtual_machine_resource Read

Update Virtual Machine Resource Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.update_virtual_machine_resource
Full name: azure-devops.azure_devops_environments_vmresource_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Properties to update Virtual Machine Resource
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	Id of the Environment
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_pipelines_environments_environmentid_providers_virtualmachines_pool Read

GET /{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines/pool Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines/pool (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_pipelines_environments_environmentid_providers_virtualmachines_pool
Full name: azure-devops.azure_devops_environments_pool_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	path parameter `environmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_virtual_machine_resource Read

Delete Virtual Machine Resource Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines/{resourceId} (spec: environments/7.2/environments.json).

Lua path: app.integrations.azure_devops.delete_virtual_machine_resource
Full name: azure-devops.azure_devops_environments_vmresource_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`environment_id`	number	yes	Id of the Environment
`resource_id`	number	yes	Id of the Virtual Machine Resource
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

list_installed_extensions_account_project_collection Read

List the installed extensions in the account / project collection. Official Azure DevOps REST API 7.2 endpoint: GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions (spec: extensionManagement/7.2/extensionManagement.json).

Lua path: app.integrations.azure_devops.list_installed_extensions_account_project_collection
Full name: azure-devops.azure_devops_extension_management_installed_extensions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`include_disabled_extensions`	boolean	no	If true (the default), include disabled extensions in the results.
`include_errors`	boolean	no	If true, include installed extensions with errors.
`asset_types`	string	no	Determines which files are returned in the files array. Provide the wildcard '*' to return all files, or a colon separated list to retrieve files with specific asset types.
`include_installation_issues`	boolean	no	query parameter `includeInstallationIssues`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_installed_extension_typically_this_api_is_used_enable_or_disable_extension Read

Update an installed extension. Typically this API is used to enable or disable an extension. Official Azure DevOps REST API 7.2 endpoint: PATCH https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions (spec: extensionManagement/7.2/extensionManagement.json).

Lua path: app.integrations.azure_devops.update_installed_extension_typically_this_api_is_used_enable_or_disable_extension
Full name: azure-devops.azure_devops_extension_management_installed_extensions_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_installed_extension_by_its_publisher_and_extension_name Read

Get an installed extension by its publisher and extension name. Official Azure DevOps REST API 7.2 endpoint: GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName} (spec: extensionManagement/7.2/extensionManagement.json).

Lua path: app.integrations.azure_devops.get_installed_extension_by_its_publisher_and_extension_name
Full name: azure-devops.azure_devops_extension_management_installed_extensions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_name`	string	yes	Name of the publisher. Example: "fabrikam".
`extension_name`	string	yes	Name of the extension. Example: "ops-tools".
`asset_types`	string	no	Determines which files are returned in the files array. Provide the wildcard '*' to return all files, or a colon separated list to retrieve files with specific asset types.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

uninstall_specified_extension_from_account_project_collection Read

Uninstall the specified extension from the account / project collection. Official Azure DevOps REST API 7.2 endpoint: DELETE https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName} (spec: extensionManagement/7.2/extensionManagement.json).

Lua path: app.integrations.azure_devops.uninstall_specified_extension_from_account_project_collection
Full name: azure-devops.azure_devops_extension_management_installed_extensions_uninstall_extension_by_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_name`	string	yes	Name of the publisher. Example: "fabrikam".
`extension_name`	string	yes	Name of the extension. Example: "ops-tools".
`reason`	string	no	query parameter `reason`.
`reason_code`	string	no	query parameter `reasonCode`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

install_specified_extension_into_account_project_collection Read

Install the specified extension into the account / project collection. Official Azure DevOps REST API 7.2 endpoint: POST https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}/{version} (spec: extensionManagement/7.2/extensionManagement.json).

Lua path: app.integrations.azure_devops.install_specified_extension_into_account_project_collection
Full name: azure-devops.azure_devops_extension_management_installed_extensions_install_extension_by_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_name`	string	yes	Name of the publisher. Example: "fabrikam".
`extension_name`	string	yes	Name of the extension. Example: "ops-tools".
`version`	string	yes	path parameter `version`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

get_organization_apis_favorite_favorites Read

GET /{organization}/_apis/favorite/favorites Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/favorite/favorites (spec: favorite/7.2/favorite.json).

Lua path: app.integrations.azure_devops.get_organization_apis_favorite_favorites
Full name: azure-devops.azure_devops_favorite_favorites_get_favorites

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`artifact_type`	string	no	query parameter `artifactType`.
`artifact_scope_type`	string	no	query parameter `artifactScopeType`.
`artifact_scope_id`	string	no	query parameter `artifactScopeId`.
`include_extended_details`	boolean	no	query parameter `includeExtendedDetails`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_apis_favorite_favorites Write

POST /{organization}/_apis/favorite/favorites Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/favorite/favorites (spec: favorite/7.2/favorite.json).

Lua path: app.integrations.azure_devops.post_organization_apis_favorite_favorites
Full name: azure-devops.azure_devops_favorite_favorites_create_favorite

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_favorite_favorites_favoriteid Read

GET /{organization}/_apis/favorite/favorites/{favoriteId} Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/favorite/favorites/{favoriteId} (spec: favorite/7.2/favorite.json).

Lua path: app.integrations.azure_devops.get_organization_apis_favorite_favorites_favoriteid
Full name: azure-devops.azure_devops_favorite_favorites_get_favorite_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`favorite_id`	string	yes	path parameter `favoriteId`.
`artifact_scope_type`	string	no	query parameter `artifactScopeType`.
`artifact_type`	string	no	query parameter `artifactType`.
`artifact_scope_id`	string	no	query parameter `artifactScopeId`.
`include_extended_details`	boolean	no	query parameter `includeExtendedDetails`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_apis_favorite_favorites_favoriteid Write

DELETE /{organization}/_apis/favorite/favorites/{favoriteId} Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/favorite/favorites/{favoriteId} (spec: favorite/7.2/favorite.json).

Lua path: app.integrations.azure_devops.delete_organization_apis_favorite_favorites_favoriteid
Full name: azure-devops.azure_devops_favorite_favorites_delete_favorite_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`favorite_id`	string	yes	path parameter `favoriteId`.
`artifact_type`	string	no	query parameter `artifactType`.
`artifact_scope_type`	string	no	query parameter `artifactScopeType`.
`artifact_scope_id`	string	no	query parameter `artifactScopeId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_deleted_git_repositories Read

Retrieve deleted git repositories. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/deletedrepositories (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_deleted_git_repositories
Full name: azure-devops.azure_devops_git_repositories_get_deleted_repositories

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_refs_favorites_repo_and_identity Read

Gets the refs favorites for a repo and an identity. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refs (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.gets_refs_favorites_repo_and_identity
Full name: azure-devops.azure_devops_git_refs_favorites_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	no	The id of the repository.
`identity_id`	string	no	The id of the identity whose favorites are to be retrieved. If null, the requesting identity is used.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_ref_favorite Read

Creates a ref favorite Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refs (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.creates_ref_favorite
Full name: azure-devops.azure_devops_git_refs_favorites_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The ref favorite to create.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_refs_favorite_favorite_id Read

Gets the refs favorite for a favorite Id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refs/{favoriteId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.gets_refs_favorite_favorite_id
Full name: azure-devops.azure_devops_git_refs_favorites_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`favorite_id`	number	yes	The Id of the requested ref favorite.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_refs_favorite_specified Read

Deletes the refs favorite specified Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refs/{favoriteId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.deletes_refs_favorite_specified
Full name: azure-devops.azure_devops_git_refs_favorites_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`favorite_id`	number	yes	The Id of the ref favorite to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_git_favorites_refsforproject Read

GET /{organization}/{project}/_apis/git/favorites/refsForProject Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refsForProject (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_git_favorites_refsforproject
Full name: azure-devops.azure_devops_git_refs_favorites_for_project_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`identity_id`	string	no	query parameter `identityId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_list_policy_configurations_by_given_set_scope_filtering_criteria_repos_uses_two_types_policies_protect_your_code_repository_policies_push_policies_check_every_push_your_repository_they_validate_things_like_file_size_limits_path_restrictions_or_commit_requirements_when_someone_pushes_code_that_violates_these_rules_push_gets_rejected_no_matter_which_branch_they_pushing_branch_policies_pr_policies_protect_specific_branches_by_requiring_pull_requests_when_you_set_branch_policy_main_example_nobody_can_push_directly_main_anymore_they_must_create_pull_request_instead_which_can_then_require_reviews_builds_or_other_checks_pass_first_how_policies_work_with_your_project_structure_both_types_policies_can_be_defined_at_different_levels_your_project_hierarchy_policy_defined_at_project_level_affects_all_repositories_that_project_policy_defined_at_repository_level_affects_just_that_repository_branch_policy_can_even_be_defined_at_project_level_protect_all_branches_with_same_name_like_protecting_all_main_branches_across_your_entire_project_with_one_policy_branch_patterns_and_wildcards_branches_git_follow_folder_like_structure_you_might_have_branches_like_refs_heads_main_refs_heads_releases_1_0_0_refs_heads_releases_2_0_0_refs_heads_features_new_login_you_can_create_policies_specific_branches_or_groups_branches_using_wildcards_when_you_create_policy_refs_heads_releases_it_protects_all_branches_releases_folder_both_ones_that_exist_now_and_any_new_release_branches_you_create_later_this_pattern_matching_works_recursively_so_refs_heads_releases_also_covers_branches_like_refs_heads_releases_v1_hotfix_this_helps_you_set_up_consistent_protection_without_creating_same_policy_over_and_over_example_you_can_require_two_reviewers_all_release_branches_with_just_one_policy_understanding_policy_inheritance_when_you_query_policies_this_endpoint_shows_you_what_policies_are_actually_enforcing_rules_at_your_specified_scope_this_includes_policies_inherited_from_higher_levels_example_if_you_query_policies_specific_branch_you_get_branch_policies_that_exact_branch_branch_policies_with_wildcards_that_match_your_branch_repository_policies_that_repo_any_applicable_project_level_policies_everything_that_protects_that_branch_shows_up_your_results_how_query_policies_repositoryid_and_refname_parameters_let_you_focus_specific_parts_your_project_here_what_you_get_with_different_combinations_both_repositoryid_and_refname_specified_when_refname_is_specific_branch_name_you_see_all_policies_affecting_that_specific_branch_this_includes_exact_branch_policies_wildcard_branch_policies_that_match_repository_policies_that_repo_and_any_project_level_policies_when_refname_is_all_you_see_every_policy_that_affects_any_branch_that_repository_this_special_value_gives_you_same_results_if_you_called_this_api_once_every_single_branch_repo_and_then_combined_all_results_removing_duplicates_you_get_all_branch_specific_policies_all_wildcard_policies_all_repository_policies_and_all_inherited_project_level_policies_that_apply_this_repository_this_helps_you_see_complete_picture_what_protects_all_your_branches_without_making_multiple_api_calls_only_repositoryid_specified_you_see_policies_that_apply_repository_whole_repository_policies_and_inherited_project_level_repository_policies_branch_policies_aren_t_included_because_they_don_t_affect_whole_repository_neither_parameter_specified_you_see_only_project_level_repository_policies_branch_policies_defined_at_project_level_aren_t_included_even_though_they_exist_at_project_level_this_happens_because_branch_policies_need_branch_context_be_meaningful_without_specifying_repository_or_branch_name_api_only_returns_policies_that_apply_repositories_whole_only_refname_specified_you_see_project_level_branch_policies_branches_with_that_name_like_all_main_branch_policies_defined_at_project_level_plus_project_level_repository_policies_you_can_add_policytype_parameter_filter_specific_type_policy_such_minimum_number_reviewers_or_file_size_restriction_this_parameter_accepts_policy_type_id_and_filters_results_show_only_that_specific_policy_type_common_scenarios_what_protects_my_main_branch_use_repositoryid_refname_refs_heads_main_what_protects_all_my_release_branches_use_repositoryid_refname_refs_heads_releases_show_me_every_policy_that_affects_any_branch_this_repository_use_repositoryid_refname_all_what_repository_policies_apply_this_repo_use_repositoryid_only_what_file_size_limits_apply_this_repository_use_repositoryid_with_policytype_file_size_restrictions_what_project_wide_repository_policies_do_we_have_don_t_specify_repositoryid_or_refname_which_policies_apply_develop_branches_across_all_repositories_use_refname_refs_heads_develop

Read

Retrieve a list of policy configurations by a given set of scope/filtering criteria. Azure Repos uses two types of policies to protect your code: **Repository policies (push policies)** check every push to your repository. They validate things like file size limits, path restrictions, or commit requirements. When someone pushes code that violates these rules, the push gets rejected - no matter which branch they're pushing to. **Branch policies (PR policies)** protect specific branches by requiring pull requests. When you set a branch policy on `main`, for example, nobody can push directly to `main` anymore. They must create a pull request instead, which can then require reviews, builds, or other checks to pass first. ## How Policies Work with Your Project Structure Both types of policies can be defined at different levels in your project hierarchy. A policy defined at the project level affects all repositories in that project. A policy defined at the repository level affects just that repository. A branch policy can even be defined at the project level to protect all branches with the same name - like protecting all `main` branches across your entire project with one policy. ### Branch Patterns and Wildcards Branches in Git follow a folder-like structure. You might have branches like: - `refs/heads/main` - `refs/heads/releases/1.0.0` - `refs/heads/releases/2.0.0` - `refs/heads/features/new-login` You can create policies for specific branches or for groups of branches using wildcards. When you create a policy for `refs/heads/releases/*`, it protects all branches in the `releases` "folder" - both the ones that exist now and any new release branches you create later. This pattern matching works recursively, so `refs/heads/releases/*` also covers branches like `refs/heads/releases/v1/hotfix`. This helps you set up consistent protection without creating the same policy over and over. For example, you can require two reviewers for all release branches with just one policy. ## Understanding Policy Inheritance When you query for policies, this endpoint shows you what policies are actually enforcing rules at your specified scope. This includes policies inherited from higher levels. For example, if you query for policies on a specific branch, you get: - Branch policies for that exact branch - Branch policies with wildcards that match your branch - Repository policies for that repo - Any applicable project-level policies Everything that protects that branch shows up in your results. ## How to Query for Policies The `repositoryId` and `refName` parameters let you focus on specific parts of your project. Here's what you get with different combinations: **Both `repositoryId` and `refName` specified:** - When `refName` is a specific branch name: You see all policies affecting that specific branch. This includes exact branch policies, wildcard branch policies that match, repository policies for that repo, and any project-level policies. - When `refName` is `~all`: You see every policy that affects any branch in that repository. This special value gives you the same results as if you called this API once for every single branch in the repo and then combined all the results (removing duplicates). You get all branch-specific policies, all wildcard policies, all repository policies, and all inherited project-level policies that apply to this repository. This helps you see the complete picture of what protects all your branches without making multiple API calls. **Only `repositoryId` specified:** You see policies that apply to the repository as a whole - repository policies and inherited project-level repository policies. Branch policies aren't included because they don't affect the whole repository. **Neither parameter specified:** You see only project-level repository policies. Branch policies defined at the project level aren't included, even though they exist at the project level. This happens because branch policies need a branch context to be meaningful - without specifying a repository or branch name, the API only returns policies that apply to repositories as a whole. **Only `refName` specified:** You see project-level branch policies for branches with that name (like all `main` branch policies defined at project level), plus project-level repository policies. You can add the `policyType` parameter to filter for a specific type of policy, such as "Minimum number of reviewers" or "File size restriction". This parameter accepts the policy type ID and filters the results to show only that specific policy type. ## Common Scenarios - **"What protects my main branch?"** - Use `repositoryId` + `refName=refs/heads/main` - **"What protects all my release branches?"** - Use `repositoryId` + `refName=refs/heads/releases/*` - **"Show me every policy that affects any branch in this repository"** - Use `repositoryId` + `refName=~all` - **"What repository policies apply to this repo?"** - Use `repositoryId` only - **"What file size limits apply to this repository?"** - Use `repositoryId` with the `policyType` for file size restrictions - **"What project-wide repository policies do we have?"** - Don't specify `repositoryId` or `refName` - **"Which policies apply to develop branches across all repositories?"** - Use `refName=refs/heads/develop` Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/policy/configurations (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_list_policy_configurations_by_given_set_scope_filtering_criteria_repos_uses_two_types_policies_protect_your_code_repository_policies_push_policies_check_every_push_your_repository_they_validate_things_like_file_size_limits_path_restrictions_or_commit_requirements_when_someone_pushes_code_that_violates_these_rules_push_gets_rejected_no_matter_which_branch_they_pushing_branch_policies_pr_policies_protect_specific_branches_by_requiring_pull_requests_when_you_set_branch_policy_main_example_nobody_can_push_directly_main_anymore_they_must_create_pull_request_instead_which_can_then_require_reviews_builds_or_other_checks_pass_first_how_policies_work_with_your_project_structure_both_types_policies_can_be_defined_at_different_levels_your_project_hierarchy_policy_defined_at_project_level_affects_all_repositories_that_project_policy_defined_at_repository_level_affects_just_that_repository_branch_policy_can_even_be_defined_at_project_level_protect_all_branches_with_same_name_like_protecting_all_main_branches_across_your_entire_project_with_one_policy_branch_patterns_and_wildcards_branches_git_follow_folder_like_structure_you_might_have_branches_like_refs_heads_main_refs_heads_releases_1_0_0_refs_heads_releases_2_0_0_refs_heads_features_new_login_you_can_create_policies_specific_branches_or_groups_branches_using_wildcards_when_you_create_policy_refs_heads_releases_it_protects_all_branches_releases_folder_both_ones_that_exist_now_and_any_new_release_branches_you_create_later_this_pattern_matching_works_recursively_so_refs_heads_releases_also_covers_branches_like_refs_heads_releases_v1_hotfix_this_helps_you_set_up_consistent_protection_without_creating_same_policy_over_and_over_example_you_can_require_two_reviewers_all_release_branches_with_just_one_policy_understanding_policy_inheritance_when_you_query_policies_this_endpoint_shows_you_what_policies_are_actually_enforcing_rules_at_your_specified_scope_this_includes_policies_inherited_from_higher_levels_example_if_you_query_policies_specific_branch_you_get_branch_policies_that_exact_branch_branch_policies_with_wildcards_that_match_your_branch_repository_policies_that_repo_any_applicable_project_level_policies_everything_that_protects_that_branch_shows_up_your_results_how_query_policies_repositoryid_and_refname_parameters_let_you_focus_specific_parts_your_project_here_what_you_get_with_different_combinations_both_repositoryid_and_refname_specified_when_refname_is_specific_branch_name_you_see_all_policies_affecting_that_specific_branch_this_includes_exact_branch_policies_wildcard_branch_policies_that_match_repository_policies_that_repo_and_any_project_level_policies_when_refname_is_all_you_see_every_policy_that_affects_any_branch_that_repository_this_special_value_gives_you_same_results_if_you_called_this_api_once_every_single_branch_repo_and_then_combined_all_results_removing_duplicates_you_get_all_branch_specific_policies_all_wildcard_policies_all_repository_policies_and_all_inherited_project_level_policies_that_apply_this_repository_this_helps_you_see_complete_picture_what_protects_all_your_branches_without_making_multiple_api_calls_only_repositoryid_specified_you_see_policies_that_apply_repository_whole_repository_policies_and_inherited_project_level_repository_policies_branch_policies_aren_t_included_because_they_don_t_affect_whole_repository_neither_parameter_specified_you_see_only_project_level_repository_policies_branch_policies_defined_at_project_level_aren_t_included_even_though_they_exist_at_project_level_this_happens_because_branch_policies_need_branch_context_be_meaningful_without_specifying_repository_or_branch_name_api_only_returns_policies_that_apply_repositories_whole_only_refname_specified_you_see_project_level_branch_policies_branches_with_that_name_like_all_main_branch_policies_defined_at_project_level_plus_project_level_repository_policies_you_can_add_policytype_parameter_filter_specific_type_policy_such_minimum_number_reviewers_or_file_size_restriction_this_parameter_accepts_policy_type_id_and_filters_results_show_only_that_specific_policy_type_common_scenarios_what_protects_my_main_branch_use_repositoryid_refname_refs_heads_main_what_protects_all_my_release_branches_use_repositoryid_refname_refs_heads_releases_show_me_every_policy_that_affects_any_branch_this_repository_use_repositoryid_refname_all_what_repository_policies_apply_this_repo_use_repositoryid_only_what_file_size_limits_apply_this_repository_use_repositoryid_with_policytype_file_size_restrictions_what_project_wide_repository_policies_do_we_have_don_t_specify_repositoryid_or_refname_which_policies_apply_develop_branches_across_all_repositories_use_refname_refs_heads_develop
Full name: azure-devops.azure_devops_git_policy_configurations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	no	The unique identifier of a specific repository to query policies for - when provided, returns policies that apply to this repository including inherited project-level policies.
`ref_name`	string	no	The branch reference to query policies for (e.g., "refs/heads/main" for a specific branch or "~all" to get all policies affecting any branch in the repository) - determines which branch-specific policies are included in the results.
`policy_type`	string	no	The type ID of a specific policy to filter by (e.g., "Minimum number of reviewers" or "File size restriction") - when specified, returns only policies of this particular type rather than all policy types.
`top`	number	no	The maximum number of policy configurations to return in a single response - useful for limiting result size when dealing with projects that have many policies.
`continuation_token`	string	no	A token returned in the x-ms-continuationtoken response header from a previous request when not all results were returned - use this token to retrieve the next page of results in the dataset.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_all_pull_requests_matching_specified_criteria_please_note_that_description_field_will_be_truncated_up_400_symbols_result

Read

Retrieve all pull requests matching a specified criteria. Please note that description field will be truncated up to 400 symbols in the result. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/pullrequests (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_all_pull_requests_matching_specified_criteria_please_note_that_description_field_will_be_truncated_up_400_symbols_result
Full name: azure-devops.azure_devops_git_pull_requests_get_pull_requests_by_project

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`search_criteria_creator_id`	string	no	If set, search for pull requests that were created by this identity.
`search_criteria_include_links`	boolean	no	Whether to include the _links field on the shallow references
`search_criteria_labels`	array	no	If set, filters pull requests that have labels matching the specified label names.
`search_criteria_max_time`	string	no	If specified, filters pull requests that created/closed before this date based on the queryTimeRangeType specified.
`search_criteria_min_time`	string	no	If specified, filters pull requests that created/closed after this date based on the queryTimeRangeType specified.
`search_criteria_query_time_range_type`	string	no	The type of time range which should be used for minTime and maxTime. Defaults to Created if unset.
`search_criteria_repository_id`	string	no	If set, search for pull requests whose target branch is in this repository.
`search_criteria_reviewer_id`	string	no	If set, search for pull requests that have this identity as a reviewer.
`search_criteria_source_ref_name`	string	no	If set, search for pull requests from this branch.
`search_criteria_source_repository_id`	string	no	If set, search for pull requests whose source branch is in this repository.
`search_criteria_status`	string	no	If set, search for pull requests that are in this state. Defaults to Active if unset.
`search_criteria_tags_filter_operator`	string	no	The operator used for filtering by labels. Defaults to And if unset. When And is used, pull requests must have all specified labels. When Or is used, pull requests must have at least one of the specified labels.
`search_criteria_target_ref_name`	string	no	If set, search for pull requests into this branch.
`search_criteria_title`	string	no	If set, filters pull requests that contain the specified text in the title.
`max_comment_length`	number	no	Not used.
`skip`	number	no	The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
`top`	number	no	The number of pull requests to retrieve.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_pull_request Read

Retrieve a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/pullrequests/{pullRequestId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_pull_request
Full name: azure-devops.azure_devops_git_pull_requests_get_pull_request_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`pull_request_id`	number	yes	The ID of the pull request to retrieve.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_soft_deleted_git_repositories_from_recycle_bin Read

Retrieve soft-deleted git repositories from the recycle bin. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/recycleBin/repositories (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_soft_deleted_git_repositories_from_recycle_bin
Full name: azure-devops.azure_devops_git_repositories_get_recycle_bin_repositories

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

recover_soft_deleted_git_repository_recently_deleted_repositories_go_into_soft_delete_state_period_time_before_they_are_hard_deleted_and_become_unrecoverable

Read

Recover a soft-deleted Git repository. Recently deleted repositories go into a soft-delete state for a period of time before they are hard deleted and become unrecoverable. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/recycleBin/repositories/{repositoryId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.recover_soft_deleted_git_repository_recently_deleted_repositories_go_into_soft_delete_state_period_time_before_they_are_hard_deleted_and_become_unrecoverable
Full name: azure-devops.azure_devops_git_repositories_restore_repository_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	The ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

destroy_hard_delete_soft_deleted_git_repository Write

Destroy (hard delete) a soft-deleted Git repository. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/recycleBin/repositories/{repositoryId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.destroy_hard_delete_soft_deleted_git_repository
Full name: azure-devops.azure_devops_git_repositories_delete_repository_from_recycle_bin

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	The ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_git_repositories Read

Retrieve git repositories. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_git_repositories
Full name: azure-devops.azure_devops_git_repositories_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`include_links`	boolean	no	[optional] True to include reference links. The default value is false.
`include_all_urls`	boolean	no	[optional] True to include all remote URLs. The default value is false.
`include_hidden`	boolean	no	[optional] True to include hidden repositories. The default value is false.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_git_repository_team_project Read

Create a git repository in a team project. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_git_repository_team_project
Full name: azure-devops.azure_devops_git_repositories_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Specify the repo name, team project and/or parent repository. Team project information can be omitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
`project`	string	yes	Project ID or project name
`source_ref`	string	no	[optional] Specify the source refs to use while creating a fork repo
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_git_repository Read

Retrieve a git repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_git_repository
Full name: azure-devops.azure_devops_git_repositories_get_repository

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_git_repository_with_either_new_repo_name_or_new_default_branch Read

Updates the Git repository with either a new repo name or a new default branch. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.updates_git_repository_with_either_new_repo_name_or_new_default_branch
Full name: azure-devops.azure_devops_git_repositories_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Specify a new repo name or a new default branch of the repository
`repository_id`	string	yes	The ID of the repository.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_git_repository Read

Delete a git repository Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.delete_git_repository
Full name: azure-devops.azure_devops_git_repositories_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The ID of the repository.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_annotated_tag_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id

Read

Create an annotated tag. Repositories have both a name and an identifier. Identifiers are globally unique, but several projects may contain a repository of the same name. You don't need to include the project if you specify a repository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID). Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/annotatedtags (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_annotated_tag_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id
Full name: azure-devops.azure_devops_git_annotated_tags_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Object containing details of tag to be created.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	ID or name of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_annotated_tag_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id

Read

Get an annotated tag. Repositories have both a name and an identifier. Identifiers are globally unique, but several projects may contain a repository of the same name. You don't need to include the project if you specify a repository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID). Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/annotatedtags/{objectId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_annotated_tag_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id
Full name: azure-devops.azure_devops_git_annotated_tags_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	ID or name of the repository.
`object_id`	string	yes	ObjectId (Sha1Id) of tag to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_one_or_more_blobs_zip_file_download Read

Gets one or more blobs in a zip file download. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/blobs (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.gets_one_or_more_blobs_zip_file_download
Full name: azure-devops.azure_devops_git_blobs_get_blobs_zip

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Blob IDs (SHA1 hashes) to be returned in the zip file.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`filename`	string	no	query parameter `filename`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_single_blob_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id

Read

Get a single blob. Repositories have both a name and an identifier. Identifiers are globally unique, but several projects may contain a repository of the same name. You don't need to include the project if you specify a repository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID). Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/blobs/{sha1} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_single_blob_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id
Full name: azure-devops.azure_devops_git_blobs_get_blob

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`sha1`	string	yes	SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
`project`	string	yes	Project ID or project name
`download`	boolean	no	If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
`file_name`	string	no	Provide a fileName to use for a download.
`format`	string	no	Options: json, zip, text, octetstream. If not set, defaults to the MIME type set in the Accept header.
`resolve_lfs`	boolean	no	If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_information_about_cherry_pick_operation_specific_branch_this_operation_is_expensive_due_underlying_object_structure_so_this_api_only_looks_at_1000_most_recent_cherry_pick_operations

Read

Retrieve information about a cherry pick operation for a specific branch. This operation is expensive due to the underlying object structure, so this API only looks at the 1000 most recent cherry pick operations. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_information_about_cherry_pick_operation_specific_branch_this_operation_is_expensive_due_underlying_object_structure_so_this_api_only_looks_at_1000_most_recent_cherry_pick_operations
Full name: azure-devops.azure_devops_git_cherry_picks_get_cherry_pick_for_ref_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	ID of the repository.
`ref_name`	string	no	The GitAsyncRefOperationParameters generatedRefName used for the cherry pick operation.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

cherry_pick_specific_commit_or_commits_that_are_associated_pull_request_into_new_branch Read

Cherry pick a specific commit or commits that are associated to a pull request into a new branch. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.cherry_pick_specific_commit_or_commits_that_are_associated_pull_request_into_new_branch
Full name: azure-devops.azure_devops_git_cherry_picks_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_information_about_cherry_pick_operation_by_cherry_pick_id Read

Retrieve information about a cherry pick operation by cherry pick Id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks/{cherryPickId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_information_about_cherry_pick_operation_by_cherry_pick_id
Full name: azure-devops.azure_devops_git_cherry_picks_get_cherry_pick

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`cherry_pick_id`	number	yes	ID of the cherry pick.
`repository_id`	string	yes	ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_list_commits_associated_with_particular_push Read

Retrieve a list of commits associated with a particular push. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_list_commits_associated_with_particular_push
Full name: azure-devops.azure_devops_git_commits_get_push_commits

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
`push_id`	number	no	The id of the push.
`project`	string	yes	Project ID or project name
`top`	number	no	The maximum number of commits to return ("get the top x commits").
`skip`	number	no	The number of commits to skip.
`include_links`	boolean	no	Set to false to avoid including REST Url links for resources. Defaults to true.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_particular_commit Read

Retrieve a particular commit. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_particular_commit
Full name: azure-devops.azure_devops_git_commits_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`commit_id`	string	yes	The id of the commit.
`repository_id`	string	yes	The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
`project`	string	yes	Project ID or project name
`change_count`	number	no	The number of changes to include in the result.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_changes_particular_commit Read

Retrieve changes for a particular commit. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}/changes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_changes_particular_commit
Full name: azure-devops.azure_devops_git_commits_get_changes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`commit_id`	string	yes	The id of the commit.
`repository_id`	string	yes	The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
`project`	string	yes	Project ID or project name
`top`	number	no	The maximum number of changes to return.
`skip`	number	no	The number of changes to skip.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_statuses_associated_with_git_commit Read

Get statuses associated with the Git commit. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_statuses_associated_with_git_commit
Full name: azure-devops.azure_devops_git_statuses_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`commit_id`	string	yes	ID of the Git commit.
`repository_id`	string	yes	ID of the repository.
`project`	string	yes	Project ID or project name
`top`	number	no	Optional. The number of statuses to retrieve. Default is 1000.
`skip`	number	no	Optional. The number of statuses to ignore. Default is 0. For example, to retrieve results 101-150, set top to 50 and skip to 100.
`latest_only`	boolean	no	The flag indicates whether to get only latest statuses grouped by `Context.Name` and `Context.Genre`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_git_commit_status Read

Create Git commit status. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_git_commit_status
Full name: azure-devops.azure_devops_git_statuses_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Git commit status object to create.
`commit_id`	string	yes	ID of the Git commit.
`repository_id`	string	yes	ID of the repository.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_git_commits_project_matching_search_criteria Read

Retrieve git commits for a project matching the search criteria Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_git_commits_project_matching_search_criteria
Full name: azure-devops.azure_devops_git_commits_get_commits_batch

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Search options
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`skip`	number	no	Number of commits to skip. The value cannot exceed 3,000,000.
`top`	number	no	Maximum number of commits to return. The value cannot exceed 50,000.
`include_statuses`	boolean	no	True to include additional commit status information.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

find_closest_common_commit_merge_base_between_base_and_target_commits_and_get_diff_between_either_base_and_target_commits_or_common_and_target_commits

Read

Find the closest common commit (the merge base) between base and target commits, and get the diff between either the base and target commits or common and target commits. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/diffs/commits (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.find_closest_common_commit_merge_base_between_base_and_target_commits_and_get_diff_between_either_base_and_target_commits_or_common_and_target_commits
Full name: azure-devops.azure_devops_git_diffs_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`diff_common_commit`	boolean	no	If true, diff between common and target commits. If false, diff between base and target commits.
`top`	number	no	Maximum number of changes to return. Defaults to 100.
`skip`	number	no	Number of changes to skip
`base_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`base_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`base_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`target_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`target_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`target_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_import_requests_repository Read

Retrieve import requests for a repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/importRequests (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_import_requests_repository
Full name: azure-devops.azure_devops_git_import_requests_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	The name or ID of the repository.
`include_abandoned`	boolean	no	True to include abandoned import requests in the results.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_import_request Read

Create an import request. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/importRequests (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_import_request
Full name: azure-devops.azure_devops_git_import_requests_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The import request to create.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	The name or ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_particular_import_request Read

Retrieve a particular import request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/importRequests/{importRequestId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_particular_import_request
Full name: azure-devops.azure_devops_git_import_requests_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	The name or ID of the repository.
`import_request_id`	number	yes	The unique identifier for the import request.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retry_or_abandon_failed_import_request_there_can_only_be_one_active_import_request_associated_with_repository_marking_failed_import_request_abandoned_makes_it_inactive

Read

Retry or abandon a failed import request. There can only be one active import request associated with a repository. Marking a failed import request abandoned makes it inactive. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/importRequests/{importRequestId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retry_or_abandon_failed_import_request_there_can_only_be_one_active_import_request_associated_with_repository_marking_failed_import_request_abandoned_makes_it_inactive
Full name: azure-devops.azure_devops_git_import_requests_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The updated version of the import request. Currently, the only change allowed is setting the Status to Queued or Abandoned.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	The name or ID of the repository.
`import_request_id`	number	yes	The unique identifier for the import request to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_item_metadata_and_or_content_collection_items_download_parameter_is_indicate_whether_content_should_be_available_download_or_just_sent_stream_response_doesn_t_apply_zipped_content_which_is_always_returned_download

Read

Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_item_metadata_and_or_content_collection_items_download_parameter_is_indicate_whether_content_should_be_available_download_or_just_sent_stream_response_doesn_t_apply_zipped_content_which_is_always_returned_download
Full name: azure-devops.azure_devops_git_items_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`scope_path`	string	no	The path scope. The default is null.
`recursion_level`	string	no	The recursion level of this request. The default is 'none', no recursion.
`include_content_metadata`	boolean	no	Set to true to include content metadata. Default is false.
`latest_processed_change`	boolean	no	Set to true to include the latest changes. Default is false.
`download`	boolean	no	Set to true to download the response as a file. Default is false.
`include_links`	boolean	no	Set to true to include links to items. Default is false.
`format`	string	no	If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'. If $format is specified, then api-version should also be specified as a query parameter.
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`zip_for_unix`	boolean	no	Set to true to keep the file permissions for unix (and POSIX) systems like executables and symlinks
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieves_batch_items_repo_project_given_list_paths_or_long_path Read

Retrieves a batch of items in a repo / project for a given list of paths or a long path Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/itemsbatch (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieves_batch_items_repo_project_given_list_paths_or_long_path
Full name: azure-devops.azure_devops_git_items_get_items_batch

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request data attributes: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Collection of items to fetch, including path, version, and recursion level. IncludeContentMetadata: Whether to include metadata for all items LatestProcessedChange: Whether to include shallow ref to commit that last changed each item. IncludeLinks: Whether to include the _links field on the shallow references.
`repository_id`	string	yes	The name or ID of the repository
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_files_attached_given_pull_request Read

Get a list of files attached to a given pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/attachments (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_list_files_attached_given_pull_request
Full name: azure-devops.azure_devops_git_pull_request_attachments_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_file_content_pull_request_attachment Read

Get the file content of a pull request attachment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/attachments/{fileName} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_file_content_pull_request_attachment
Full name: azure-devops.azure_devops_git_pull_request_attachments_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`file_name`	string	yes	The name of the attachment.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

attach_new_file_pull_request Read

Attach a new file to a pull request. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/attachments/{fileName} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.attach_new_file_pull_request
Full name: azure-devops.azure_devops_git_pull_request_attachments_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Raw payload: provide `content` as a string and optional `content_type`.
`file_name`	string	yes	The name of the file.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_pull_request_attachment Read

Delete a pull request attachment. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/attachments/{fileName} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.delete_pull_request_attachment
Full name: azure-devops.azure_devops_git_pull_request_attachments_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`file_name`	string	yes	The name of the attachment to delete.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_commits_specified_pull_request Read

Get the commits for the specified pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/commits (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_commits_specified_pull_request
Full name: azure-devops.azure_devops_git_pull_request_commits_get_pull_request_commits

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	ID or name of the repository.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`top`	number	no	Maximum number of commits to return.
`continuation_token`	string	no	The continuation token used for pagination.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_iterations_specified_pull_request Read

Get the list of iterations for the specified pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_list_iterations_specified_pull_request
Full name: azure-devops.azure_devops_git_pull_request_iterations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	ID or name of the repository.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`include_commits`	boolean	no	If true, include the commits associated with each iteration in the response.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_specified_iteration_pull_request Read

Get the specified iteration for a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_specified_iteration_pull_request
Full name: azure-devops.azure_devops_git_pull_request_iterations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	ID or name of the repository.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration to return.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_changes_made_pull_request_between_two_iterations Read

Retrieve the changes made in a pull request between two iterations. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/changes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_changes_made_pull_request_between_two_iterations
Full name: azure-devops.azure_devops_git_pull_request_iteration_changes_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration. <br /> Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch. Allowed values are between 1 and the maximum iteration on this pull request.
`project`	string	yes	Project ID or project name
`top`	number	no	Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
`skip`	number	no	Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
`compare_to`	number	no	ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_commits_specified_iteration_pull_request Read

Get the commits for the specified iteration of a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/commits (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_commits_specified_iteration_pull_request
Full name: azure-devops.azure_devops_git_pull_request_commits_get_pull_request_iteration_commits

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	ID or name of the repository.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the iteration from which to get the commits.
`project`	string	yes	Project ID or project name
`top`	number	no	Maximum number of commits to return. The maximum number of commits that can be returned per batch is 500.
`skip`	number	no	Number of commits to skip.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_statuses_associated_with_pull_request_iteration Read

Get all the statuses associated with a pull request iteration. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_all_statuses_associated_with_pull_request_iteration
Full name: azure-devops.azure_devops_git_pull_request_iteration_statuses_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_pull_request_status_iteration_this_operation_will_have_same_result_create_status_pull_request_with_specified_iteration_id_request_body_only_required_field_status_is_context_name_that_uniquely_identifies_status_note_that_iterationid_request_body_is_optional_since_iterationid_can_be_specified_url_conflict_between_iterationid_url_and_iterationid_request_body_will_result_status_code_400

Read

Create a pull request status on the iteration. This operation will have the same result as Create status on pull request with specified iteration ID in the request body. The only required field for the status is `Context.Name` that uniquely identifies the status. Note that `iterationId` in the request body is optional since `iterationId` can be specified in the URL. A conflict between `iterationId` in the URL and `iterationId` in the request body will result in status code 400. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_pull_request_status_iteration_this_operation_will_have_same_result_create_status_pull_request_with_specified_iteration_id_request_body_only_required_field_status_is_context_name_that_uniquely_identifies_status_note_that_iterationid_request_body_is_optional_since_iterationid_can_be_specified_url_conflict_between_iterationid_url_and_iterationid_request_body_will_result_status_code_400
Full name: azure-devops.azure_devops_git_pull_request_iteration_statuses_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Pull request status to create.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_pull_request_iteration_statuses_collection_only_supported_operation_type_is_remove_this_operation_allows_delete_multiple_statuses_one_call_path_remove_operation_should_refer_id_pull_request_status_example_path_1_refers_pull_request_status_with_id_1

Read

Update pull request iteration statuses collection. The only supported operation type is `remove`. This operation allows to delete multiple statuses in one call. The path of the `remove` operation should refer to the ID of the pull request status. For example `path="/1"` refers to the pull request status with ID 1. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.update_pull_request_iteration_statuses_collection_only_supported_operation_type_is_remove_this_operation_allows_delete_multiple_statuses_one_call_path_remove_operation_should_refer_id_pull_request_status_example_path_1_refers_pull_request_status_with_id_1
Full name: azure-devops.azure_devops_git_pull_request_iteration_statuses_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Operations to apply to the pull request statuses in JSON Patch format.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_specific_pull_request_iteration_status_by_id_status_id_is_unique_within_pull_request_across_all_iterations Read

Get the specific pull request iteration status by ID. The status ID is unique within the pull request across all iterations. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses/{statusId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_specific_pull_request_iteration_status_by_id_status_id_is_unique_within_pull_request_across_all_iterations
Full name: azure-devops.azure_devops_git_pull_request_iteration_statuses_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration.
`status_id`	number	yes	ID of the pull request status.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_pull_request_iteration_status_you_can_remove_multiple_statuses_one_call_by_using_update_operation Read

Delete pull request iteration status. You can remove multiple statuses in one call by using Update operation. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses/{statusId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.delete_pull_request_iteration_status_you_can_remove_multiple_statuses_one_call_by_using_update_operation
Full name: azure-devops.azure_devops_git_pull_request_iteration_statuses_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`iteration_id`	number	yes	ID of the pull request iteration.
`status_id`	number	yes	ID of the pull request status.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_all_labels_tags_assigned_pull_request Read

Get all the labels (tags) assigned to a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_all_labels_tags_assigned_pull_request
Full name: azure-devops.azure_devops_git_pull_request_labels_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`project_id`	string	no	Project ID or project name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_tag_if_that_does_not_exists_yet_and_add_that_label_tag_specified_pull_request_only_required_field_is_name_new_label_tag

Read

Create a tag (if that does not exists yet) and add that as a label (tag) for a specified pull request. The only required field is the name of the new label (tag). Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_tag_if_that_does_not_exists_yet_and_add_that_label_tag_specified_pull_request_only_required_field_is_name_new_label_tag
Full name: azure-devops.azure_devops_git_pull_request_labels_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Label to assign to the pull request.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`project_id`	string	no	Project ID or project name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieves_single_label_tag_that_has_been_assigned_pull_request Read

Retrieves a single label (tag) that has been assigned to a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels/{labelIdOrName} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieves_single_label_tag_that_has_been_assigned_pull_request
Full name: azure-devops.azure_devops_git_pull_request_labels_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`label_id_or_name`	string	yes	The name or ID of the label requested.
`project`	string	yes	Project ID or project name
`project_id`	string	no	Project ID or project name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_label_tag_from_set_those_assigned_pull_request_tag_itself_will_not_be_deleted Read

Removes a label (tag) from the set of those assigned to the pull request. The tag itself will not be deleted. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels/{labelIdOrName} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.removes_label_tag_from_set_those_assigned_pull_request_tag_itself_will_not_be_deleted
Full name: azure-devops.azure_devops_git_pull_request_labels_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`label_id_or_name`	string	yes	The name or ID of the label requested.
`project`	string	yes	Project ID or project name
`project_id`	string	no	Project ID or project name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_external_properties_pull_request Read

Get external properties of the pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/properties (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_external_properties_pull_request
Full name: azure-devops.azure_devops_git_pull_request_properties_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_or_update_pull_request_external_properties_patch_operation_can_be_add_replace_or_remove_add_operation_path_can_be_empty_if_path_is_empty_value_must_be_list_key_value_pairs_replace_operation_path_cannot_be_empty_if_path_does_not_exist_property_will_be_added_collection_remove_operation_path_cannot_be_empty_if_path_does_not_exist_no_action_will_be_performed

Read

Create or update pull request external properties. The patch operation can be `add`, `replace` or `remove`. For `add` operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For `replace` operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For `remove` operation, the path cannot be empty. If the path does not exist, no action will be performed. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/properties (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_or_update_pull_request_external_properties_patch_operation_can_be_add_replace_or_remove_add_operation_path_can_be_empty_if_path_is_empty_value_must_be_list_key_value_pairs_replace_operation_path_cannot_be_empty_if_path_does_not_exist_property_will_be_added_collection_remove_operation_path_cannot_be_empty_if_path_does_not_exist_no_action_will_be_performed
Full name: azure-devops.azure_devops_git_pull_request_properties_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Properties to add, replace or remove in JSON Patch format.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_reviewers_pull_request Read

Retrieve the reviewers for a pull request Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_reviewers_pull_request
Full name: azure-devops.azure_devops_git_pull_request_reviewers_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_reviewers_pull_request Write

Add reviewers to a pull request. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.add_reviewers_pull_request
Full name: azure-devops.azure_devops_git_pull_request_reviewers_create_pull_request_reviewers

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Reviewers to add to the pull request.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_unmaterialized_identity_reviewers_pull_request Write

Add an unmaterialized identity to the reviewers of a pull request. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.add_unmaterialized_identity_reviewers_pull_request
Full name: azure-devops.azure_devops_git_pull_request_reviewers_create_unmaterialized_pull_request_reviewer

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Reviewer to add to the pull request.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

reset_votes_multiple_reviewers_pull_request_note_this_endpoint_only_supports_updating_votes_but_does_not_support_updating_required_reviewers_use_policy_or_display_names

Write

Reset the votes of multiple reviewers on a pull request. NOTE: This endpoint only supports updating votes, but does not support updating required reviewers (use policy) or display names. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.reset_votes_multiple_reviewers_pull_request_note_this_endpoint_only_supports_updating_votes_but_does_not_support_updating_required_reviewers_use_policy_or_display_names
Full name: azure-devops.azure_devops_git_pull_request_reviewers_update_pull_request_reviewers

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	IDs of the reviewers whose votes will be reset to zero
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_information_about_particular_reviewer_pull_request Read

Retrieve information about a particular reviewer on a pull request Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_information_about_particular_reviewer_pull_request
Full name: azure-devops.azure_devops_git_pull_request_reviewers_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`reviewer_id`	string	yes	ID of the reviewer.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_reviewer_pull_request_or_cast_vote Write

Add a reviewer to a pull request or cast a vote. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.add_reviewer_pull_request_or_cast_vote
Full name: azure-devops.azure_devops_git_pull_request_reviewers_create_pull_request_reviewer

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Reviewer's vote.<br />If the reviewer's ID is included here, it must match the reviewerID parameter.<br />Reviewers can set their own vote with this method. When adding other reviewers, vote must be set to zero.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`reviewer_id`	string	yes	ID of the reviewer.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

edit_reviewer_entry_these_fields_are_patchable_isflagged_hasdeclined Write

Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.edit_reviewer_entry_these_fields_are_patchable_isflagged_hasdeclined
Full name: azure-devops.azure_devops_git_pull_request_reviewers_update_pull_request_reviewer

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Reviewer data.<br />If the reviewer's ID is included here, it must match the reviewerID parameter.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`reviewer_id`	string	yes	ID of the reviewer.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

remove_reviewer_from_pull_request Read

Remove a reviewer from a pull request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.remove_reviewer_from_pull_request
Full name: azure-devops.azure_devops_git_pull_request_reviewers_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`reviewer_id`	string	yes	ID of the reviewer to remove.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

sends_mail_notification_about_specific_pull_request_set_recipients Read

Sends an e-mail notification about a specific pull request to a set of recipients Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/share (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.sends_mail_notification_about_specific_pull_request_set_recipients
Full name: azure-devops.azure_devops_git_pull_request_share_share_pull_request

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`repository_id`	string	yes	ID of the git repository.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_statuses_associated_with_pull_request Read

Get all the statuses associated with a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_all_statuses_associated_with_pull_request
Full name: azure-devops.azure_devops_git_pull_request_statuses_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_pull_request_status_only_required_field_status_is_context_name_that_uniquely_identifies_status_note_that_you_can_specify_iterationid_request_body_post_status_iteration

Read

Create a pull request status. The only required field for the status is `Context.Name` that uniquely identifies the status. Note that you can specify iterationId in the request body to post the status on the iteration. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_pull_request_status_only_required_field_status_is_context_name_that_uniquely_identifies_status_note_that_you_can_specify_iterationid_request_body_post_status_iteration
Full name: azure-devops.azure_devops_git_pull_request_statuses_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Pull request status to create.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_pull_request_statuses_collection_only_supported_operation_type_is_remove_this_operation_allows_delete_multiple_statuses_one_call_path_remove_operation_should_refer_id_pull_request_status_example_path_1_refers_pull_request_status_with_id_1

Read

Update pull request statuses collection. The only supported operation type is `remove`. This operation allows to delete multiple statuses in one call. The path of the `remove` operation should refer to the ID of the pull request status. For example `path="/1"` refers to the pull request status with ID 1. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.update_pull_request_statuses_collection_only_supported_operation_type_is_remove_this_operation_allows_delete_multiple_statuses_one_call_path_remove_operation_should_refer_id_pull_request_status_example_path_1_refers_pull_request_status_with_id_1
Full name: azure-devops.azure_devops_git_pull_request_statuses_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Operations to apply to the pull request statuses in JSON Patch format.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_specific_pull_request_status_by_id_status_id_is_unique_within_pull_request_across_all_iterations Read

Get the specific pull request status by ID. The status ID is unique within the pull request across all iterations. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_specific_pull_request_status_by_id_status_id_is_unique_within_pull_request_across_all_iterations
Full name: azure-devops.azure_devops_git_pull_request_statuses_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`status_id`	number	yes	ID of the pull request status.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_pull_request_status_you_can_remove_multiple_statuses_one_call_by_using_update_operation Read

Delete pull request status. You can remove multiple statuses in one call by using Update operation. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.delete_pull_request_status_you_can_remove_multiple_statuses_one_call_by_using_update_operation
Full name: azure-devops.azure_devops_git_pull_request_statuses_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request’s target branch.
`pull_request_id`	number	yes	ID of the pull request.
`status_id`	number	yes	ID of the pull request status.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_all_threads_pull_request Read

Retrieve all threads in a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_all_threads_pull_request
Full name: azure-devops.azure_devops_git_pull_request_threads_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`iteration`	number	no	If specified, thread positions will be tracked using this iteration as the right side of the diff.
`base_iteration`	number	no	If specified, thread positions will be tracked using this iteration as the left side of the diff.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_thread_pull_request Read

Create a thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_threads_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The thread to create. Thread must contain at least one comment.
`repository_id`	string	yes	Repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_thread_pull_request Read

Retrieve a thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_threads_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread.
`project`	string	yes	Project ID or project name
`iteration`	number	no	If specified, thread position will be tracked using this iteration as the right side of the diff.
`base_iteration`	number	no	If specified, thread position will be tracked using this iteration as the left side of the diff.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_thread_pull_request Read

Update a thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.update_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_threads_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The thread content that should be updated.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_all_comments_associated_with_specific_thread_pull_request Read

Retrieve all comments associated with a specific thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_all_comments_associated_with_specific_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_thread_comments_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_comment_specific_thread_pull_request_up_500_comments_can_be_created_per_thread Read

Create a comment on a specific thread in a pull request (up to 500 comments can be created per thread). Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_comment_specific_thread_pull_request_up_500_comments_can_be_created_per_thread
Full name: azure-devops.azure_devops_git_pull_request_thread_comments_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The comment to create. Comments can be up to 150,000 characters.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread that the desired comment is in.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_comment_associated_with_specific_thread_pull_request Read

Retrieve a comment associated with a specific thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_comment_associated_with_specific_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_thread_comments_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread that the desired comment is in.
`comment_id`	number	yes	ID of the comment.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_comment_associated_with_specific_thread_pull_request Read

Update a comment associated with a specific thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.update_comment_associated_with_specific_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_thread_comments_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The comment content that should be updated. Comments can be up to 150,000 characters.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread that the desired comment is in.
`comment_id`	number	yes	ID of the comment to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_comment_associated_with_specific_thread_pull_request Read

Delete a comment associated with a specific thread in a pull request. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.delete_comment_associated_with_specific_thread_pull_request
Full name: azure-devops.azure_devops_git_pull_request_thread_comments_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	ID of the thread that the desired comment is in.
`comment_id`	number	yes	ID of the comment.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_likes_comment Read

Get likes for a comment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId}/likes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_likes_comment
Full name: azure-devops.azure_devops_git_pull_request_comment_likes_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	The ID of the thread that contains the comment.
`comment_id`	number	yes	The ID of the comment.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_like_comment Read

Add a like on a comment. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId}/likes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.add_like_comment
Full name: azure-devops.azure_devops_git_pull_request_comment_likes_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	The ID of the thread that contains the comment.
`comment_id`	number	yes	The ID of the comment.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

delete_like_comment Read

Delete a like on a comment. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId}/likes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.delete_like_comment
Full name: azure-devops.azure_devops_git_pull_request_comment_likes_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request.
`thread_id`	number	yes	The ID of the thread that contains the comment.
`comment_id`	number	yes	The ID of the comment.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_list_work_items_associated_with_pull_request Read

Retrieve a list of work items associated with a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/workitems (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_list_work_items_associated_with_pull_request
Full name: azure-devops.azure_devops_git_pull_request_work_items_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	ID or name of the repository.
`pull_request_id`	number	yes	ID of the pull request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

this_api_is_used_find_what_pull_requests_are_related_given_commit_it_can_be_used_either_find_pull_request_that_created_particular_merge_commit_or_it_can_be_used_find_all_pull_requests_that_have_ever_merged_particular_commit_input_is_list_queries_which_each_contain_list_commits_each_commit_that_you_search_against_you_will_get_back_dictionary_commit_pull_requests

Read

This API is used to find what pull requests are related to a given commit. It can be used to either find the pull request that created a particular merge commit or it can be used to find all pull requests that have ever merged a particular commit. The input is a list of queries which each contain a list of commits. For each commit that you search against, you will get back a dictionary of commit -> pull requests. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequestquery (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.this_api_is_used_find_what_pull_requests_are_related_given_commit_it_can_be_used_either_find_pull_request_that_created_particular_merge_commit_or_it_can_be_used_find_all_pull_requests_that_have_ever_merged_particular_commit_input_is_list_queries_which_each_contain_list_commits_each_commit_that_you_search_against_you_will_get_back_dictionary_commit_pull_requests
Full name: azure-devops.azure_devops_git_pull_request_query_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The list of queries to perform.
`repository_id`	string	yes	ID of the repository.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_all_pull_requests_matching_specified_criteria_please_note_that_description_field_will_be_truncated_up_400_symbols_result

Read

Lua path: app.integrations.azure_devops.retrieve_all_pull_requests_matching_specified_criteria_please_note_that_description_field_will_be_truncated_up_400_symbols_result
Full name: azure-devops.azure_devops_git_pull_requests_get_pull_requests

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`project`	string	yes	Project ID or project name
`search_criteria_creator_id`	string	no	If set, search for pull requests that were created by this identity.
`search_criteria_include_links`	boolean	no	Whether to include the _links field on the shallow references
`search_criteria_labels`	array	no	If set, filters pull requests that have labels matching the specified label names.
`search_criteria_max_time`	string	no	If specified, filters pull requests that created/closed before this date based on the queryTimeRangeType specified.
`search_criteria_min_time`	string	no	If specified, filters pull requests that created/closed after this date based on the queryTimeRangeType specified.
`search_criteria_query_time_range_type`	string	no	The type of time range which should be used for minTime and maxTime. Defaults to Created if unset.
`search_criteria_repository_id`	string	no	If set, search for pull requests whose target branch is in this repository.
`search_criteria_reviewer_id`	string	no	If set, search for pull requests that have this identity as a reviewer.
`search_criteria_source_ref_name`	string	no	If set, search for pull requests from this branch.
`search_criteria_source_repository_id`	string	no	If set, search for pull requests whose source branch is in this repository.
`search_criteria_status`	string	no	If set, search for pull requests that are in this state. Defaults to Active if unset.
`search_criteria_tags_filter_operator`	string	no	The operator used for filtering by labels. Defaults to And if unset. When And is used, pull requests must have all specified labels. When Or is used, pull requests must have at least one of the specified labels.
`search_criteria_target_ref_name`	string	no	If set, search for pull requests into this branch.
`search_criteria_title`	string	no	If set, filters pull requests that contain the specified text in the title.
`max_comment_length`	number	no	Not used.
`skip`	number	no	The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
`top`	number	no	The number of pull requests to retrieve.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_pull_request Read

Create a pull request. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.create_pull_request
Full name: azure-devops.azure_devops_git_pull_requests_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The pull request to create.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`project`	string	yes	Project ID or project name
`supports_iterations`	boolean	no	If true, subsequent pushes to the pull request will be individually reviewable. Set this to false for large pull requests for performance reasons if this functionality is not needed.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_pull_request Read

Retrieve a pull request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_pull_request
Full name: azure-devops.azure_devops_git_pull_requests_get_pull_request

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	The ID of the pull request to retrieve.
`project`	string	yes	Project ID or project name
`max_comment_length`	number	no	Not used.
`skip`	number	no	Not used.
`top`	number	no	Not used.
`include_commits`	boolean	no	If true, the pull request will be returned with the associated commits.
`include_work_item_refs`	boolean	no	If true, the pull request will be returned with the associated work item references.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_pull_request_these_are_properties_that_can_be_updated_with_api_status_title_description_up_4000_characters_completionoptions_mergeoptions_autocompletesetby_id_targetrefname_when_pr_retargeting_feature_is_enabled_attempting_update_other_properties_outside_this_list_will_either_cause_server_throw_invalidargumentvalueexception_or_silently_ignore_update

Read

Update a pull request These are the properties that can be updated with the API: - Status - Title - Description (up to 4000 characters) - CompletionOptions - MergeOptions - AutoCompleteSetBy.Id - TargetRefName (when the PR retargeting feature is enabled) Attempting to update other properties outside of this list will either cause the server to throw an `InvalidArgumentValueException`, or to silently ignore the update. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.update_pull_request_these_are_properties_that_can_be_updated_with_api_status_title_description_up_4000_characters_completionoptions_mergeoptions_autocompletesetby_id_targetrefname_when_pr_retargeting_feature_is_enabled_attempting_update_other_properties_outside_this_list_will_either_cause_server_throw_invalidargumentvalueexception_or_silently_ignore_update
Full name: azure-devops.azure_devops_git_pull_requests_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The pull request content that should be updated.
`repository_id`	string	yes	The repository ID of the pull request's target branch.
`pull_request_id`	number	yes	ID of the pull request to update.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieves_pushes_associated_with_specified_repository Read

Retrieves pushes associated with the specified repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieves_pushes_associated_with_specified_repository
Full name: azure-devops.azure_devops_git_pushes_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`skip`	number	no	Number of pushes to skip.
`top`	number	no	Number of pushes to return.
`search_criteria_from_date`	string	no	Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.
`search_criteria_include_links`	boolean	no	Whether to include the _links field on the shallow references
`search_criteria_include_ref_updates`	boolean	no	Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.
`search_criteria_pusher_id`	string	no	Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.
`search_criteria_ref_name`	string	no	Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.
`search_criteria_to_date`	string	no	Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

push_changes_repository Read

Push changes to the repository. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.push_changes_repository
Full name: azure-devops.azure_devops_git_pushes_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

retrieves_particular_push Read

Retrieves a particular push. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieves_particular_push
Full name: azure-devops.azure_devops_git_pushes_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`push_id`	number	yes	ID of the push.
`project`	string	yes	Project ID or project name
`include_commits`	number	no	The number of commits to include in the result.
`include_ref_updates`	boolean	no	If true, include the list of refs that were updated by the push.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

queries_provided_repository_its_refs_and_returns_them Read

Queries the provided repository for its refs and returns them. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.queries_provided_repository_its_refs_and_returns_them
Full name: azure-devops.azure_devops_git_refs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`filter`	string	no	[optional] A filter to apply to the refs (starts with).
`include_links`	boolean	no	[optional] Specifies if referenceLinks should be included in the result. default is false.
`include_statuses`	boolean	no	[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
`include_my_branches`	boolean	no	[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
`latest_statuses_only`	boolean	no	[optional] True to include only the tip commit status for each ref. This option requires `includeStatuses` to be true. The default value is false.
`peel_tags`	boolean	no	[optional] Annotated tags will populate the PeeledObjectId property. default is false.
`filter_contains`	string	no	[optional] A filter to apply to the refs (contains).
`top`	number	no	[optional] Maximum number of refs to return. It cannot be bigger than 1000. If it is not provided but continuationToken is, top will default to 100.
`continuation_token`	string	no	The continuation token used for pagination.
`include_target_branches`	boolean	no	[optional] Includes target branches defined by patterns in pull_request_targets.yml.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creating_updating_or_deleting_refs_branches_updating_ref_means_making_it_point_at_different_commit_than_it_used_you_must_specify_both_old_and_new_commit_avoid_race_conditions

Write

Creating, updating, or deleting refs(branches). Updating a ref means making it point at a different commit than it used to. You must specify both the old and new commit to avoid race conditions. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.creating_updating_or_deleting_refs_branches_updating_ref_means_making_it_point_at_different_commit_than_it_used_you_must_specify_both_old_and_new_commit_avoid_race_conditions
Full name: azure-devops.azure_devops_git_refs_update_refs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of ref updates to attempt to perform
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`project_id`	string	no	ID or name of the team project. Optional if specifying an ID for repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

lock_or_unlock_branch Write

Lock or Unlock a branch. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.lock_or_unlock_branch
Full name: azure-devops.azure_devops_git_refs_update_ref

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The ref update action (lock/unlock) to perform
`repository_id`	string	yes	The name or ID of the repository.
`filter`	string	no	The name of the branch to lock/unlock
`project`	string	yes	Project ID or project name
`project_id`	string	no	ID or name of the team project. Optional if specifying an ID for repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_information_about_revert_operation_specific_branch Read

Retrieve information about a revert operation for a specific branch. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/reverts (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_information_about_revert_operation_specific_branch
Full name: azure-devops.azure_devops_git_reverts_get_revert_for_ref_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	ID of the repository.
`ref_name`	string	no	The GitAsyncRefOperationParameters generatedRefName used for the revert operation.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

starts_operation_create_new_branch_which_reverts_changes_introduced_by_either_specific_commit_or_commits_that_are_associated_pull_request

Read

Starts the operation to create a new branch which reverts changes introduced by either a specific commit or commits that are associated to a pull request. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/reverts (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.starts_operation_create_new_branch_which_reverts_changes_introduced_by_either_specific_commit_or_commits_that_are_associated_pull_request
Full name: azure-devops.azure_devops_git_reverts_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`repository_id`	string	yes	ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_information_about_revert_operation_by_revert_id Read

Retrieve information about a revert operation by revert Id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/reverts/{revertId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_information_about_revert_operation_by_revert_id
Full name: azure-devops.azure_devops_git_reverts_get_revert

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`revert_id`	number	yes	ID of the revert operation.
`repository_id`	string	yes	ID of the repository.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_statistics_about_all_branches_within_repository Read

Retrieve statistics about all branches within a repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/stats/branches (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_statistics_about_all_branches_within_repository
Full name: azure-devops.azure_devops_git_stats_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`base_version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`base_version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`base_version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieve_pull_request_suggestion_particular_repository_or_team_project Read

Retrieve a pull request suggestion for a particular repository or team project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/suggestions (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_pull_request_suggestion_particular_repository_or_team_project
Full name: azure-devops.azure_devops_git_suggestions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	ID of the git repository.
`project`	string	yes	Project ID or project name
`prefer_compare_branch`	boolean	no	If true, prefer the compare branch over the default branch as target branch for pull requests.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

tree_endpoint_returns_collection_objects_underneath_specified_tree_trees_are_folders_git_repository_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id

Read

The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. Repositories have both a name and an identifier. Identifiers are globally unique, but several projects may contain a repository of the same name. You don't need to include the project if you specify a repository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/trees/{sha1} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.tree_endpoint_returns_collection_objects_underneath_specified_tree_trees_are_folders_git_repository_repositories_have_both_name_and_identifier_identifiers_are_globally_unique_but_several_projects_may_contain_repository_same_name_you_don_t_need_include_project_if_you_specify_repository_by_id_however_if_you_specify_repository_by_name_you_must_also_specify_project_by_name_or_id
Full name: azure-devops.azure_devops_git_trees_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_id`	string	yes	Repository Id.
`sha1`	string	yes	SHA1 hash of the tree object.
`project`	string	yes	Project ID or project name
`project_id`	string	no	Project Id.
`recursive`	boolean	no	Search recursively. Include trees underneath this tree. Default is false.
`file_name`	string	no	Name to use if a .zip file is returned. Default is the object ID.
`format`	string	no	Use "zip". Defaults to the MIME type set in the Accept header.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

find_merge_bases_two_commits_optionally_across_forks_if_otherrepositoryid_is_not_specified_merge_bases_will_only_be_calculated_within_context_local_repositorynameorid

Write

Find the merge bases of two commits, optionally across forks. If otherRepositoryId is not specified, the merge bases will only be calculated within the context of the local repositoryNameOrId. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/commits/{commitId}/mergebases (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.find_merge_bases_two_commits_optionally_across_forks_if_otherrepositoryid_is_not_specified_merge_bases_will_only_be_calculated_within_context_local_repositorynameorid
Full name: azure-devops.azure_devops_git_merge_bases_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_name_or_id`	string	yes	ID or name of the local repository.
`commit_id`	string	yes	First commit, usually the tip of the target branch of the potential merge.
`other_commit_id`	string	no	Other commit, usually the tip of the source branch of the potential merge.
`project`	string	yes	Project ID or project name
`other_collection_id`	string	no	The collection ID where otherCommitId lives.
`other_repository_id`	string	no	The repository ID where otherCommitId lives.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_all_requested_fork_sync_operations_this_repository Read

Retrieve all requested fork sync operations on this repository. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_all_requested_fork_sync_operations_this_repository
Full name: azure-devops.azure_devops_git_forks_get_fork_sync_requests

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_name_or_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`include_abandoned`	boolean	no	True to include abandoned requests.
`include_links`	boolean	no	True to include links.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

request_that_another_repository_refs_be_fetched_into_this_one_it_syncs_two_existing_forks_create_fork_please_see_href_https_docs_microsoft_com_en_rest_api_vsts_git_repositories_create_view_rest_5_1_repositories_endpoint

Write

Request that another repository's refs be fetched into this one. It syncs two existing forks. To create a fork, please see the <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> repositories endpoint</a> Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.request_that_another_repository_refs_be_fetched_into_this_one_it_syncs_two_existing_forks_create_fork_please_see_href_https_docs_microsoft_com_en_rest_api_vsts_git_repositories_create_view_rest_5_1_repositories_endpoint
Full name: azure-devops.azure_devops_git_forks_create_fork_sync_request

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Source repository and ref mapping.
`repository_name_or_id`	string	yes	The name or ID of the repository.
`project`	string	yes	Project ID or project name
`include_links`	boolean	no	True to include links
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_fork_sync_operation_details Read

Get a specific fork sync operation's details. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests/{forkSyncOperationId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_specific_fork_sync_operation_details
Full name: azure-devops.azure_devops_git_forks_get_fork_sync_request

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_name_or_id`	string	yes	The name or ID of the repository.
`fork_sync_operation_id`	number	yes	OperationId of the sync request.
`project`	string	yes	Project ID or project name
`include_links`	boolean	no	True to include links.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_all_forks_repository_collection Read

Retrieve all forks of a repository in the collection. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forks/{collectionId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.retrieve_all_forks_repository_collection
Full name: azure-devops.azure_devops_git_forks_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`repository_name_or_id`	string	yes	The name or ID of the repository.
`collection_id`	string	yes	Team project collection ID.
`project`	string	yes	Project ID or project name
`include_links`	boolean	no	True to include links.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

request_git_merge_operation_currently_we_support_merging_only_2_commits Read

Request a git merge operation. Currently we support merging only 2 commits. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/merges (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.request_git_merge_operation_currently_we_support_merging_only_2_commits
Full name: azure-devops.azure_devops_git_merges_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Parents commitIds and merge commit messsage.
`project`	string	yes	Project ID or project name
`repository_name_or_id`	string	yes	The name or ID of the repository.
`include_links`	boolean	no	True to include links
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_merge_operation_details Read

Get a specific merge operation's details. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/merges/{mergeOperationId} (spec: git/7.2/git.json).

Lua path: app.integrations.azure_devops.get_specific_merge_operation_details
Full name: azure-devops.azure_devops_git_merges_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository_name_or_id`	string	yes	The name or ID of the repository.
`merge_operation_id`	number	yes	OperationId of the merge request.
`include_links`	boolean	no	True to include links
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_memberships_where_this_descriptor_is_member_relationship_default_value_direction_is_up_meaning_return_all_memberships_where_subject_is_member_g_all_groups_subject_is_member_alternatively_passing_direction_down_will_return_all_memberships_where_subject_is_container_g_all_members_subject_group

Read

Get all the memberships where this descriptor is a member in the relationship. The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group). Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/Memberships/{subjectDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_all_memberships_where_this_descriptor_is_member_relationship_default_value_direction_is_up_meaning_return_all_memberships_where_subject_is_member_g_all_groups_subject_is_member_alternatively_passing_direction_down_will_return_all_memberships_where_subject_is_container_g_all_members_subject_group
Full name: azure-devops.azure_devops_graph_memberships_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_descriptor`	string	yes	Fetch all direct memberships of this descriptor.
`direction`	string	no	Defaults to Up.
`depth`	number	no	The maximum number of edges to traverse up or down the membership tree. Currently the only supported value is '1'.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_graph_subjects_subjectdescriptor_avatars Read

GET /{organization}/_apis/graph/Subjects/{subjectDescriptor}/avatars Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/Subjects/{subjectDescriptor}/avatars (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_organization_apis_graph_subjects_subjectdescriptor_avatars
Full name: azure-devops.azure_devops_graph_avatars_get

Parameter	Type	Required	Description
`subject_descriptor`	string	yes	path parameter `subjectDescriptor`.
`organization`	string	yes	The name of the Azure DevOps organization.
`size`	string	no	query parameter `size`.
`format`	string	no	query parameter `format`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

put_organization_apis_graph_subjects_subjectdescriptor_avatars Read

PUT /{organization}/_apis/graph/Subjects/{subjectDescriptor}/avatars Official Azure DevOps REST API 7.2 endpoint: PUT https://vssps.dev.azure.com/{organization}/_apis/graph/Subjects/{subjectDescriptor}/avatars (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.put_organization_apis_graph_subjects_subjectdescriptor_avatars
Full name: azure-devops.azure_devops_graph_avatars_set_avatar

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subject_descriptor`	string	yes	path parameter `subjectDescriptor`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_apis_graph_subjects_subjectdescriptor_avatars Read

DELETE /{organization}/_apis/graph/Subjects/{subjectDescriptor}/avatars Official Azure DevOps REST API 7.2 endpoint: DELETE https://vssps.dev.azure.com/{organization}/_apis/graph/Subjects/{subjectDescriptor}/avatars (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.delete_organization_apis_graph_subjects_subjectdescriptor_avatars
Full name: azure-devops.azure_devops_graph_avatars_delete

Parameter	Type	Required	Description
`subject_descriptor`	string	yes	path parameter `subjectDescriptor`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_graph_users_userdescriptor_providerinfo Read

GET /{organization}/_apis/graph/Users/{userDescriptor}/providerinfo Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/Users/{userDescriptor}/providerinfo (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_organization_apis_graph_users_userdescriptor_providerinfo
Full name: azure-devops.azure_devops_graph_provider_info_get

Parameter	Type	Required	Description
`user_descriptor`	string	yes	path parameter `userDescriptor`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

resolve_storage_key_descriptor Read

Resolve a storage key to a descriptor Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/descriptors/{storageKey} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.resolve_storage_key_descriptor
Full name: azure-devops.azure_devops_graph_descriptors_get

Parameter	Type	Required	Description
`storage_key`	string	yes	Storage key of the subject (user, group, scope, etc.) to resolve
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_all_groups_current_scope_usually_organization_or_account_optional_parameters_are_used_filter_down_returned_results_returned_results_are_no_guaranteed_order_since_list_groups_may_be_large_results_are_returned_pages_groups_if_there_are_more_results_than_can_be_returned_single_page_result_set_will_contain_continuation_token_retrieval_next_set_results

Read

Gets a list of all groups in the current scope (usually organization or account). The optional parameters are used to filter down the returned results. Returned results are in no guaranteed order. Since the list of groups may be large, results are returned in pages of groups. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/groups (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.gets_list_all_groups_current_scope_usually_organization_or_account_optional_parameters_are_used_filter_down_returned_results_returned_results_are_no_guaranteed_order_since_list_groups_may_be_large_results_are_returned_pages_groups_if_there_are_more_results_than_can_be_returned_single_page_result_set_will_contain_continuation_token_retrieval_next_set_results
Full name: azure-devops.azure_devops_graph_groups_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`scope_descriptor`	string	no	Specify a non-default scope (collection, project) to search for groups.
`subject_types`	string	no	A comma separated list of user subject subtypes to reduce the retrieved results, e.g. Microsoft.IdentityModel.Claims.ClaimsIdentity
`continuation_token`	string	no	An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_group_or_materialize_existing_aad_group_body_request_must_be_derived_type_graphgroupcreationcontext_graphgroupvstscreationcontext_create_new_group_that_is_not_backed_by_external_provider_graphgroupmailaddresscreationcontext_create_new_group_using_mail_address_reference_existing_group_from_external_ad_or_aad_backed_provider_graphgrouporiginidcreationcontext_create_new_group_using_originid_reference_group_from_external_ad_or_aad_backed_provider_optionally_you_can_add_newly_created_group_member_existing_group_and_or_specify_custom_storage_key_group

Read

Create a new Azure DevOps group or materialize an existing AAD group. The body of the request must be a derived type of GraphGroupCreationContext: * GraphGroupVstsCreationContext - Create a new Azure DevOps group that is not backed by an external provider. * GraphGroupMailAddressCreationContext - Create a new group using the mail address as a reference to an existing group from an external AD or AAD backed provider. * GraphGroupOriginIdCreationContext - Create a new group using the OriginID as a reference to a group from an external AD or AAD backed provider. Optionally, you can add the newly created group as a member of an existing Azure DevOps group and/or specify a custom storage key for the group. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/graph/groups (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.create_new_group_or_materialize_existing_aad_group_body_request_must_be_derived_type_graphgroupcreationcontext_graphgroupvstscreationcontext_create_new_group_that_is_not_backed_by_external_provider_graphgroupmailaddresscreationcontext_create_new_group_using_mail_address_reference_existing_group_from_external_ad_or_aad_backed_provider_graphgrouporiginidcreationcontext_create_new_group_using_originid_reference_group_from_external_ad_or_aad_backed_provider_optionally_you_can_add_newly_created_group_member_existing_group_and_or_specify_custom_storage_key_group
Full name: azure-devops.azure_devops_graph_groups_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The subset of the full graph group used to uniquely find the graph subject in an external provider.
`scope_descriptor`	string	no	A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization. Valid only for VSTS groups.
`group_descriptors`	string	no	A comma separated list of descriptors referencing groups you want the graph group to join
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_group_by_its_descriptor_group_will_be_returned_even_if_it_has_been_deleted_from_account_or_has_had_all_its_memberships_deleted

Read

Get a group by its descriptor. The group will be returned even if it has been deleted from the account or has had all its memberships deleted. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/groups/{groupDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_group_by_its_descriptor_group_will_be_returned_even_if_it_has_been_deleted_from_account_or_has_had_all_its_memberships_deleted
Full name: azure-devops.azure_devops_graph_groups_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_descriptor`	string	yes	The descriptor of the desired graph group.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_properties_group_currently_limited_only_changing_description_and_account_name Read

Update the properties of an Azure DevOps group. Currently limited to only changing the description and account name. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vssps.dev.azure.com/{organization}/_apis/graph/groups/{groupDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.update_properties_group_currently_limited_only_changing_description_and_account_name
Full name: azure-devops.azure_devops_graph_groups_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_descriptor`	string	yes	The descriptor of the group to modify.
`body`	object	yes	The JSON+Patch document containing the fields to alter.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_group_from_all_its_parent_groups_group_will_still_be_visible_but_membership_checks_group_and_all_descendants_which_derive_membership_through_it_will_return_false

Read

Removes an Azure DevOps group from all of its parent groups. The group will still be visible, but membership checks for the group, and all descendants which derive membership through it, will return false.” Official Azure DevOps REST API 7.2 endpoint: DELETE https://vssps.dev.azure.com/{organization}/_apis/graph/groups/{groupDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.removes_group_from_all_its_parent_groups_group_will_still_be_visible_but_membership_checks_group_and_all_descendants_which_derive_membership_through_it_will_return_false
Full name: azure-devops.azure_devops_graph_groups_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_descriptor`	string	yes	The descriptor of the group to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_membership_relationship_between_container_and_subject Read

Get a membership relationship between a container and subject. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_membership_relationship_between_container_and_subject
Full name: azure-devops.azure_devops_graph_memberships_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_descriptor`	string	yes	A descriptor to the child subject in the relationship.
`container_descriptor`	string	yes	A descriptor to the container in the relationship.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_membership_between_container_and_subject Read

Create a new membership between a container and subject. Official Azure DevOps REST API 7.2 endpoint: PUT https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.create_new_membership_between_container_and_subject
Full name: azure-devops.azure_devops_graph_memberships_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_descriptor`	string	yes	A descriptor to a group or user that can be the child subject in the relationship.
`container_descriptor`	string	yes	A descriptor to a group that can be the container in the relationship.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

deletes_membership_between_container_and_subject Write

Deletes a membership between a container and subject. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.deletes_membership_between_container_and_subject
Full name: azure-devops.azure_devops_graph_memberships_remove_membership

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_descriptor`	string	yes	A descriptor to a group or user that is the child subject in the relationship.
`container_descriptor`	string	yes	A descriptor to a group that is the container in the relationship.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

check_whether_subject_is_active_or_inactive Read

Check whether a subject is active or inactive. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/membershipstates/{subjectDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.check_whether_subject_is_active_or_inactive
Full name: azure-devops.azure_devops_graph_membership_states_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_descriptor`	string	yes	Descriptor of the subject (user, group, scope, etc.) to check state of
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_apis_graph_requestaccess Read

POST /{organization}/_apis/graph/requestaccess Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/graph/requestaccess (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.post_organization_apis_graph_requestaccess
Full name: azure-devops.azure_devops_graph_request_access_request_access

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_all_service_principals_given_scope_since_list_service_principals_may_be_large_results_are_returned_pages_service_principals_if_there_are_more_results_than_can_be_returned_single_page_result_set_will_contain_continuation_token_retrieval_next_set_results_only_reliable_way_know_if_there_is_no_more_service_principals_left_is_lack_continuation_token

Read

Get a list of all service principals in a given scope. Since the list of service principals may be large, results are returned in pages of service principals. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. The only reliable way to know if there is no more service principals left is the lack of a continuation token. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_list_all_service_principals_given_scope_since_list_service_principals_may_be_large_results_are_returned_pages_service_principals_if_there_are_more_results_than_can_be_returned_single_page_result_set_will_contain_continuation_token_retrieval_next_set_results_only_reliable_way_know_if_there_is_no_more_service_principals_left_is_lack_continuation_token
Full name: azure-devops.azure_devops_graph_service_principals_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`continuation_token`	string	no	An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
`scope_descriptor`	string	no	Specify a non-default scope (collection, project) to search for service principals.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

materialize_existing_aad_service_principal_into_ado_account_note_created_service_principals_are_not_active_account_adding_service_principal_account_is_required_before_service_principal_can_be_added_ado_groups_or_assigned_asset_body_request_must_be_derived_type_graphserviceprincipalcreationcontext_graphserviceprincipaloriginidcreationcontext_create_new_service_principal_using_originid_reference_existing_service_principal_from_aad_backed_provider_if_service_principal_be_added_corresponds_service_principal_that_was_previously_deleted_then_that_service_principal_will_be_restored_optionally_you_can_add_newly_created_service_principal_member_existing_ado_group_and_or_specify_custom_storage_key_service_principal

Read

Materialize an existing AAD service principal into the ADO account. NOTE: Created service principals are not active in an account. Adding a service principal to an account is required before the service principal can be added to ADO groups or assigned an asset. The body of the request must be a derived type of GraphServicePrincipalCreationContext: * GraphServicePrincipalOriginIdCreationContext - Create a new service principal using the OriginID as a reference to an existing service principal from AAD backed provider. If the service principal to be added corresponds to a service principal that was previously deleted, then that service principal will be restored. Optionally, you can add the newly created service principal as a member of an existing ADO group and/or specify a custom storage key for the service principal. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.materialize_existing_aad_service_principal_into_ado_account_note_created_service_principals_are_not_active_account_adding_service_principal_account_is_required_before_service_principal_can_be_added_ado_groups_or_assigned_asset_body_request_must_be_derived_type_graphserviceprincipalcreationcontext_graphserviceprincipaloriginidcreationcontext_create_new_service_principal_using_originid_reference_existing_service_principal_from_aad_backed_provider_if_service_principal_be_added_corresponds_service_principal_that_was_previously_deleted_then_that_service_principal_will_be_restored_optionally_you_can_add_newly_created_service_principal_member_existing_ado_group_and_or_specify_custom_storage_key_service_principal
Full name: azure-devops.azure_devops_graph_service_principals_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The subset of the full graph service principal used to uniquely find the graph subject in an external provider.
`group_descriptors`	string	no	A comma separated list of descriptors of groups you want the graph service principal to join
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_service_principal_by_its_descriptor Read

Get a service principal by its descriptor. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals/{servicePrincipalDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_service_principal_by_its_descriptor
Full name: azure-devops.azure_devops_graph_service_principals_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`service_principal_descriptor`	string	yes	The descriptor of the desired service principal.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

disables_service_principal_service_principal_will_still_be_visible_but_membership_checks_service_principal_will_return_false

Read

Disables a service principal. The service principal will still be visible, but membership checks for the service principal will return false. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals/{servicePrincipalDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.disables_service_principal_service_principal_will_still_be_visible_but_membership_checks_service_principal_will_return_false
Full name: azure-devops.azure_devops_graph_service_principals_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`service_principal_descriptor`	string	yes	The descriptor of the service principal to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

resolve_descriptor_storage_key Read

Resolve a descriptor to a storage key. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/storagekeys/{subjectDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.resolve_descriptor_storage_key
Full name: azure-devops.azure_devops_graph_storage_keys_get

Parameter	Type	Required	Description
`subject_descriptor`	string	yes	path parameter `subjectDescriptor`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

resolve_descriptors_users_groups_or_scopes_subjects_batch Read

Resolve descriptors to users, groups or scopes (Subjects) in a batch. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/graph/subjectlookup (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.resolve_descriptors_users_groups_or_scopes_subjects_batch
Full name: azure-devops.azure_devops_graph_subject_lookup_lookup_subjects

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A list of descriptors that specifies a subset of subjects to retrieve. Each descriptor uniquely identifies the subject across all instance scopes, but only at a single point in time.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

search_users_or_and_groups_results_will_be_returned_batch_with_no_more_than_100_graph_subjects Read

Search for Azure Devops users, or/and groups. Results will be returned in a batch with no more than 100 graph subjects. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/graph/subjectquery (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.search_users_or_and_groups_results_will_be_returned_batch_with_no_more_than_100_graph_subjects
Full name: azure-devops.azure_devops_graph_subject_query_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The query that we'll be using to search includes the following: Query: the search term. The search will be prefix matching only. SubjectKind: "User" or "Group" can be specified, both or either ScopeDescriptor: Non-default scope can be specified, i.e. project scope descriptor
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_all_users_given_scope_since_list_users_may_be_large_results_are_returned_pages_users_if_there_are_more_results_than_can_be_returned_single_page_result_set_will_contain_continuation_token_retrieval_next_set_results

Read

Get a list of all users in a given scope. Since the list of users may be large, results are returned in pages of users. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/users (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_list_all_users_given_scope_since_list_users_may_be_large_results_are_returned_pages_users_if_there_are_more_results_than_can_be_returned_single_page_result_set_will_contain_continuation_token_retrieval_next_set_results
Full name: azure-devops.azure_devops_graph_users_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_types`	string	no	A comma separated list of user subject subtypes to reduce the retrieved results, e.g. msa’, ‘aad’, ‘svc’ (service identity), ‘imp’ (imported identity), etc.
`continuation_token`	string	no	An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
`scope_descriptor`	string	no	Specify a non-default scope (collection, project) to search for users.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

materialize_existing_aad_or_msa_user_into_ado_account_note_created_users_are_not_active_account_unless_they_have_been_explicitly_assigned_parent_group_at_creation_time_or_have_signed_and_been_autolicensed_through_aad_group_memberships_adding_user_account_is_required_before_user_can_be_added_ado_groups_or_assigned_asset_body_request_must_be_derived_type_graphusercreationcontext_graphusermailaddresscreationcontext_create_new_user_using_mail_address_reference_existing_user_from_external_ad_or_aad_backed_provider_graphuseroriginidcreationcontext_create_new_user_using_originid_reference_existing_user_from_external_ad_or_aad_backed_provider_graphuserprincipalnamecreationcontext_create_new_user_using_principal_name_reference_existing_user_from_external_ad_or_aad_backed_provider_if_user_be_added_corresponds_user_that_was_previously_deleted_then_that_user_will_be_restored_optionally_you_can_add_newly_created_user_member_existing_ado_group_and_or_specify_custom_storage_key_user

Read

Materialize an existing AAD or MSA user into the ADO account. NOTE: Created users are not active in an account unless they have been explicitly assigned a parent group at creation time or have signed in and been autolicensed through AAD group memberships. Adding a user to an account is required before the user can be added to ADO groups or assigned an asset. The body of the request must be a derived type of GraphUserCreationContext: * GraphUserMailAddressCreationContext - Create a new user using the mail address as a reference to an existing user from an external AD or AAD backed provider. * GraphUserOriginIdCreationContext - Create a new user using the OriginID as a reference to an existing user from an external AD or AAD backed provider. * GraphUserPrincipalNameCreationContext - Create a new user using the principal name as a reference to an existing user from an external AD or AAD backed provider. If the user to be added corresponds to a user that was previously deleted, then that user will be restored. Optionally, you can add the newly created user as a member of an existing ADO group and/or specify a custom storage key for the user. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/graph/users (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.materialize_existing_aad_or_msa_user_into_ado_account_note_created_users_are_not_active_account_unless_they_have_been_explicitly_assigned_parent_group_at_creation_time_or_have_signed_and_been_autolicensed_through_aad_group_memberships_adding_user_account_is_required_before_user_can_be_added_ado_groups_or_assigned_asset_body_request_must_be_derived_type_graphusercreationcontext_graphusermailaddresscreationcontext_create_new_user_using_mail_address_reference_existing_user_from_external_ad_or_aad_backed_provider_graphuseroriginidcreationcontext_create_new_user_using_originid_reference_existing_user_from_external_ad_or_aad_backed_provider_graphuserprincipalnamecreationcontext_create_new_user_using_principal_name_reference_existing_user_from_external_ad_or_aad_backed_provider_if_user_be_added_corresponds_user_that_was_previously_deleted_then_that_user_will_be_restored_optionally_you_can_add_newly_created_user_member_existing_ado_group_and_or_specify_custom_storage_key_user
Full name: azure-devops.azure_devops_graph_users_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The subset of the full graph user used to uniquely find the graph subject in an external provider.
`group_descriptors`	string	no	A comma separated list of descriptors of groups you want the graph user to join
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_user_by_its_descriptor Read

Get a user by its descriptor. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.get_user_by_its_descriptor
Full name: azure-devops.azure_devops_graph_users_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`user_descriptor`	string	yes	The descriptor of the desired user.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

map_existing_user_different_user_body_request_must_be_derived_type_graphuserupdatecontext_graphuseroriginidupdatecontext_map_existing_user_account_existing_user_from_external_ad_or_aad_backed_provider_using_originid_reference

Read

Map an existing user to a different user. The body of the request must be a derived type of GraphUserUpdateContext: * GraphUserOriginIdUpdateContext - Map an existing user in an account, to an existing user from an external AD or AAD backed provider using the OriginId as a reference. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.map_existing_user_different_user_body_request_must_be_derived_type_graphuserupdatecontext_graphuseroriginidupdatecontext_map_existing_user_account_existing_user_from_external_ad_or_aad_backed_provider_using_originid_reference
Full name: azure-devops.azure_devops_graph_users_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The subset of the full graph user used to uniquely find the graph subject in an external provider.
`user_descriptor`	string	yes	The descriptor of the user to update
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

disables_user_user_will_still_be_visible_but_membership_checks_user_will_return_false Read

Disables a user. The user will still be visible, but membership checks for the user will return false. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor} (spec: graph/7.2/graph.json).

Lua path: app.integrations.azure_devops.disables_user_user_will_still_be_visible_but_membership_checks_user_will_return_false
Full name: azure-devops.azure_devops_graph_users_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`user_descriptor`	string	yes	The descriptor of the user to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_available_service_hook_consumer_services_optionally_filter_by_consumers_that_support_at_least_one_event_type_from_specific_publisher

Read

Get a list of available service hook consumer services. Optionally filter by consumers that support at least one event type from the specific publisher. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/consumers (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_list_available_service_hook_consumer_services_optionally_filter_by_consumers_that_support_at_least_one_event_type_from_specific_publisher
Full name: azure-devops.azure_devops_hooks_consumers_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_id`	string	no	query parameter `publisherId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_consumer_service_optionally_filter_out_consumer_actions_that_do_not_support_any_event_types_specified_publisher

Read

Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_specific_consumer_service_optionally_filter_out_consumer_actions_that_do_not_support_any_event_types_specified_publisher
Full name: azure-devops.azure_devops_hooks_consumers_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`consumer_id`	string	yes	ID for a consumer.
`publisher_id`	string	no	query parameter `publisherId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_consumer_actions_specific_consumer Read

Get a list of consumer actions for a specific consumer. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}/actions (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_list_consumer_actions_specific_consumer
Full name: azure-devops.azure_devops_hooks_consumers_list_consumer_actions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`consumer_id`	string	yes	ID for a consumer.
`publisher_id`	string	no	query parameter `publisherId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_details_about_specific_consumer_action Read

Get details about a specific consumer action. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}/actions/{consumerActionId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_details_about_specific_consumer_action
Full name: azure-devops.azure_devops_hooks_consumers_get_consumer_action

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`consumer_id`	string	yes	ID for a consumer.
`consumer_action_id`	string	yes	ID for a consumerActionId.
`publisher_id`	string	no	query parameter `publisherId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_notifications_notification_includes_details_about_event_request_and_response_from_consumer_service Read

Query for notifications. A notification includes details about the event, the request to and the response from the consumer service. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/hooks/notificationsquery (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.query_notifications_notification_includes_details_about_event_request_and_response_from_consumer_service
Full name: azure-devops.azure_devops_hooks_notifications_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_publishers Read

Get a list of publishers. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/publishers (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_list_publishers
Full name: azure-devops.azure_devops_hooks_publishers_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_service_hooks_publisher Read

Get a specific service hooks publisher. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_specific_service_hooks_publisher
Full name: azure-devops.azure_devops_hooks_publishers_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_id`	string	yes	ID for a publisher.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_event_types_specific_publisher Read

Get the event types for a specific publisher. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}/eventtypes (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_event_types_specific_publisher
Full name: azure-devops.azure_devops_hooks_publishers_list_event_types

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_id`	string	yes	ID for a publisher.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_event_type Read

Get a specific event type. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}/eventtypes/{eventTypeId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_specific_event_type
Full name: azure-devops.azure_devops_hooks_publishers_get_event_type

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_id`	string	yes	ID for a publisher.
`event_type_id`	string	yes	path parameter `eventTypeId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_apis_hooks_publishers_publisherid_inputvaluesquery Read

POST /{organization}/_apis/hooks/publishers/{publisherId}/inputValuesQuery Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}/inputValuesQuery (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.post_organization_apis_hooks_publishers_publisherid_inputvaluesquery
Full name: azure-devops.azure_devops_hooks_publishers_query_input_values

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`publisher_id`	string	yes	path parameter `publisherId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_service_hook_publishers Read

Query for service hook publishers. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/hooks/publishersquery (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.query_service_hook_publishers
Full name: azure-devops.azure_devops_hooks_publishers_query_publishers

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_subscriptions Read

Get a list of subscriptions. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/subscriptions (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_list_subscriptions
Full name: azure-devops.azure_devops_hooks_subscriptions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_id`	string	no	ID for a subscription.
`event_type`	string	no	The event type to filter on (if any).
`consumer_id`	string	no	ID for a consumer.
`consumer_action_id`	string	no	ID for a consumerActionId.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_subscription Read

Create a subscription. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/hooks/subscriptions (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.create_subscription
Full name: azure-devops.azure_devops_hooks_subscriptions_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Subscription to be created.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_service_hooks_subscription Read

Get a specific service hooks subscription. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_specific_service_hooks_subscription
Full name: azure-devops.azure_devops_hooks_subscriptions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subscription_id`	string	yes	ID for a subscription.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_subscription_param_name_subscriptionid_id_subscription_that_you_wish_update_param Read

Update a subscription. <param name="subscriptionId">ID for a subscription that you wish to update.</param> Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.update_subscription_param_name_subscriptionid_id_subscription_that_you_wish_update_param
Full name: azure-devops.azure_devops_hooks_subscriptions_replace_subscription

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subscription_id`	string	yes	path parameter `subscriptionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_specific_service_hooks_subscription Read

Delete a specific service hooks subscription. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.delete_specific_service_hooks_subscription
Full name: azure-devops.azure_devops_hooks_subscriptions_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subscription_id`	string	yes	ID for a subscription.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_hooks_subscriptions_subscriptionid_diagnostics Read

GET /{organization}/_apis/hooks/subscriptions/{subscriptionId}/diagnostics Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}/diagnostics (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_organization_apis_hooks_subscriptions_subscriptionid_diagnostics
Full name: azure-devops.azure_devops_hooks_diagnostics_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subscription_id`	string	yes	path parameter `subscriptionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

put_organization_apis_hooks_subscriptions_subscriptionid_diagnostics Read

PUT /{organization}/_apis/hooks/subscriptions/{subscriptionId}/diagnostics Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}/diagnostics (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.put_organization_apis_hooks_subscriptions_subscriptionid_diagnostics
Full name: azure-devops.azure_devops_hooks_diagnostics_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subscription_id`	string	yes	path parameter `subscriptionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_notifications_specific_subscription_notification_includes_details_about_event_request_and_response_from_consumer_service

Read

Get a list of notifications for a specific subscription. A notification includes details about the event, the request to and the response from the consumer service. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}/notifications (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_list_notifications_specific_subscription_notification_includes_details_about_event_request_and_response_from_consumer_service
Full name: azure-devops.azure_devops_hooks_notifications_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subscription_id`	string	yes	ID for a subscription.
`max_results`	number	no	Maximum number of notifications to return. Default is 100.
`status`	string	no	Get only notifications with this status.
`result`	string	no	Get only notifications with this result type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_notification_subscription Read

Get a specific notification for a subscription. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}/notifications/{notificationId} (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.get_specific_notification_subscription
Full name: azure-devops.azure_devops_hooks_notifications_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subscription_id`	string	yes	ID for a subscription.
`notification_id`	number	yes	path parameter `notificationId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_service_hook_subscriptions Write

Query for service hook subscriptions. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.query_service_hook_subscriptions
Full name: azure-devops.azure_devops_hooks_subscriptions_create_subscriptions_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

sends_test_notification_this_is_useful_verifying_configuration_updated_or_new_service_hooks_subscription Read

Sends a test notification. This is useful for verifying the configuration of an updated or new service hooks subscription. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/hooks/testnotifications (spec: hooks/7.2/serviceHooks.json).

Lua path: app.integrations.azure_devops.sends_test_notification_this_is_useful_verifying_configuration_updated_or_new_service_hooks_subscription
Full name: azure-devops.azure_devops_hooks_notifications_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`use_real_data`	boolean	no	Only allow testing with real data in existing subscriptions.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

resolve_legacy_identity_information_use_with_older_apis_such_security_apis Read

Resolve legacy identity information for use with older APIs such as the Security APIs Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/identities (spec: ims/7.2/identities.json).

Lua path: app.integrations.azure_devops.resolve_legacy_identity_information_use_with_older_apis_such_security_apis
Full name: azure-devops.azure_devops_ims_identities_read_identities

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`descriptors`	string	no	A comma separated list of identity descriptors to resolve
`identity_ids`	string	no	A comma seperated list of storage keys to resolve
`subject_descriptors`	string	no	A comma seperated list of subject descriptors to resolve
`search_filter`	string	no	The type of search to perform. Values can be AccountName (domain\alias), DisplayName, MailAddress, General (display name, account name, or unique name), or LocalGroupName (only search Azure Devops groups).
`filter_value`	string	no	The search value, as specified by the searchFilter.
`query_membership`	string	no	The membership information to include with the identities. Values can be None for no membership data or Direct to include the groups that the identity is a member of and the identities that are a member of this identity (groups only)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_direct_members_group Read

Get direct members of a Group. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/GroupEntitlements/{groupId}/members (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_direct_members_group
Full name: azure-devops.azure_devops_member_entitlement_management_members_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_id`	string	yes	Id of the Group.
`max_results`	number	no	Maximum number of results to retrieve.
`paging_token`	string	no	Paging Token from the previous page fetched. If the 'pagingToken' is null, the results would be fetched from the beginning of the Members List.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

add_member_group Read

Add a member to a Group. Official Azure DevOps REST API 7.2 endpoint: PUT https://vsaex.dev.azure.com/{organization}/_apis/GroupEntitlements/{groupId}/members/{memberId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.add_member_group
Full name: azure-devops.azure_devops_member_entitlement_management_members_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_id`	string	yes	Id of the Group.
`member_id`	string	yes	Id of the member to add.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

remove_member_from_group Write

Remove a member from a Group. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vsaex.dev.azure.com/{organization}/_apis/GroupEntitlements/{groupId}/members/{memberId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.remove_member_from_group
Full name: azure-devops.azure_devops_member_entitlement_management_members_remove_member_from_group

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_id`	string	yes	Id of the group.
`member_id`	string	yes	Id of the member to remove.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_group_entitlements_account Read

Get the group entitlements for an account. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_group_entitlements_account
Full name: azure-devops.azure_devops_member_entitlement_management_group_entitlements_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_group_entitlement_with_license_rule_extension_rule Read

Create a group entitlement with license rule, extension rule. Official Azure DevOps REST API 7.2 endpoint: POST https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.create_group_entitlement_with_license_rule_extension_rule
Full name: azure-devops.azure_devops_member_entitlement_management_group_entitlements_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	GroupEntitlement object specifying License Rule, Extensions Rule for the group. Based on the rules the members of the group will be given licenses and extensions. The Group Entitlement can be used to add the group to another project level groups
`rule_option`	string	no	RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_group_entitlement_if_group_entitlement_does_not_exist_returns_null Read

Get a group entitlement. If the group entitlement does not exist, returns null. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements/{groupId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_group_entitlement_if_group_entitlement_does_not_exist_returns_null
Full name: azure-devops.azure_devops_member_entitlement_management_group_entitlements_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_id`	string	yes	ID of the group.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_entitlements_license_rule_extensions_rule_project_memberships_etc_group Read

Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements/{groupId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.update_entitlements_license_rule_extensions_rule_project_memberships_etc_group
Full name: azure-devops.azure_devops_member_entitlement_management_group_entitlements_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	JsonPatchDocument containing the operations to perform on the group.
`group_id`	string	yes	ID of the group.
`rule_option`	string	no	RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be updated and the changes are applied to it’s members (default option) or just be tested
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_group_entitlement Read

Delete a group entitlement. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements/{groupId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.delete_group_entitlement
Full name: azure-devops.azure_devops_member_entitlement_management_group_entitlements_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`group_id`	string	yes	ID of the group to delete.
`rule_option`	string	no	RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be deleted and the changes are applied to it’s members (default option) or just be tested
`remove_group_membership`	boolean	no	Optional parameter that specifies whether the group with the given ID should be removed from all other groups
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_memberentitlements Read

GET /{organization}/_apis/memberentitlements Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/memberentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_organization_apis_memberentitlements
Full name: azure-devops.azure_devops_member_entitlement_management_member_entitlements_search_member_entitlements

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`continuation_token`	string	no	query parameter `continuationToken`.
`select`	string	no	query parameter `select`.
`filter`	string	no	query parameter `$filter`.
`order_by`	string	no	query parameter `$orderBy`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

add_service_principal_assign_license_and_extensions_and_make_them_member_project_group_account_note_if_you_are_working_with_aad_app_registration_you_can_find_service_principal_your_app_enterprise_applications_and_make_sure_use_service_principal_object_id_originid_parameter_request_body

Read

Add a service principal, assign license and extensions and make them a member of a project group in an account. NOTE: If you are working with AAD app registration, you can find service principal of your app in enterprise applications, and make sure to use service principal's object id as originId parameter in the request body Official Azure DevOps REST API 7.2 endpoint: POST https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.add_service_principal_assign_license_and_extensions_and_make_them_member_project_group_account_note_if_you_are_working_with_aad_app_registration_you_can_find_service_principal_your_app_enterprise_applications_and_make_sure_use_service_principal_object_id_originid_parameter_request_body
Full name: azure-devops.azure_devops_member_entitlement_management_service_principal_entitlements_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	ServicePrincipalEntitlement object specifying License, Extensions and Project/Team groups the service principal should be added to.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

edit_entitlements_license_extensions_projects_teams_etc_one_or_more_service_principals Write

Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more service principals. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.edit_entitlements_license_extensions_projects_teams_etc_one_or_more_service_principals
Full name: azure-devops.azure_devops_member_entitlement_management_service_principal_entitlements_update_service_principal_entitlements

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	JsonPatchDocument containing the operations to perform.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_service_principal_entitlement_service_principal Read

Get Service principal Entitlement for a service principal. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements/{servicePrincipalId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_service_principal_entitlement_service_principal
Full name: azure-devops.azure_devops_member_entitlement_management_service_principal_entitlements_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`service_principal_id`	string	yes	ID of the service principal.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

edit_entitlements_license_extensions_projects_teams_etc_service_principal Write

Edit the entitlements (License, Extensions, Projects, Teams etc) for a service principal. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements/{servicePrincipalId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.edit_entitlements_license_extensions_projects_teams_etc_service_principal
Full name: azure-devops.azure_devops_member_entitlement_management_service_principal_entitlements_update_service_principal_entitlement

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	JsonPatchDocument containing the operations to perform on the service principal.
`service_principal_id`	string	yes	ID of the service principal.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_service_principal_from_account_delete_operation_includes_unassigning_extensions_and_licenses_and_removing_service_principal_from_all_project_memberships_service_principal_would_continue_have_access_account_if_it_is_member_aad_group_that_is_added_directly_account

Read

Delete a service principal from the account. The delete operation includes unassigning Extensions and Licenses and removing the service principal from all project memberships. The service principal would continue to have access to the account if it is member of an AAD group, that is added directly to the account. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements/{servicePrincipalId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.delete_service_principal_from_account_delete_operation_includes_unassigning_extensions_and_licenses_and_removing_service_principal_from_all_project_memberships_service_principal_would_continue_have_access_account_if_it_is_member_aad_group_that_is_added_directly_account
Full name: azure-devops.azure_devops_member_entitlement_management_service_principal_entitlements_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`service_principal_id`	string	yes	ID of the service principal.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_paged_set_user_entitlements_matching_filter_and_sort_criteria_built_with_properties_that_match_select_input Read

Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_paged_set_user_entitlements_matching_filter_and_sort_criteria_built_with_properties_that_match_select_input
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlements_search_user_entitlements

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`continuation_token`	string	no	Continuation token for getting the next page of data set. If null is passed, gets the first page.
`select`	string	no	Comma (",") separated list of properties to select in the result entitlements. names of the properties are - 'Projects, 'Extensions' and 'Grouprules'.
`filter`	string	no	Equality operators relating to searching user entitlements separated by and clauses. Valid filters include: licenseId, licenseStatus, userType, and name. licenseId: filters based on license assignment using license names. i.e. licenseId eq 'Account-Stakeholder' or licenseId eq 'Account-Express'. licenseStatus: filters based on license status. currently only supports disabled. i.e. licenseStatus eq 'Disabled'. To get disabled basic licenses, you would pass (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled'). userType: filters off identity type. Supported types are member or guest i.e. userType eq 'member'. name: filters on if the user's display name or email contains given input. i.e. get all users with "test" in email or displayname is "name eq 'test'". A valid query could be: (licenseId eq 'Account-Stakeholder' or (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled')) and name eq 'test' and userType eq 'guest'.
`order_by`	string	no	PropertyName and Order (separated by a space ( )) to sort on (e.g. lastAccessed desc). Order defaults to ascending. valid properties to order by are dateCreated, lastAccessed, and name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

add_user_assign_license_and_extensions_and_make_them_member_project_group_account Read

Add a user, assign license and extensions and make them a member of a project group in an account. Official Azure DevOps REST API 7.2 endpoint: POST https://vsaex.dev.azure.com/{organization}/_apis/userentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.add_user_assign_license_and_extensions_and_make_them_member_project_group_account
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlements_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	UserEntitlement object specifying License, Extensions and Project/Team groups the user should be added to.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

edit_entitlements_license_extensions_projects_teams_etc_one_or_more_users_msa_backed_organizations_may_face_limitation_when_using_this_api

Write

Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users. MSA Backed organizations may face limitation when using this API. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsaex.dev.azure.com/{organization}/_apis/userentitlements (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.edit_entitlements_license_extensions_projects_teams_etc_one_or_more_users_msa_backed_organizations_may_face_limitation_when_using_this_api
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlements_update_user_entitlements

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	JsonPatchDocument containing the operations to perform.
`do_not_send_invite_for_new_users`	boolean	no	Whether to send email invites to new users or not
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

get_user_entitlement_user Read

Get User Entitlement for a user. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_user_entitlement_user
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlements_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`user_id`	string	yes	ID of the user.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

edit_entitlements_license_extensions_projects_teams_etc_user_msa_backed_organizations_may_face_limitation_when_using_this_api

Write

Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. MSA Backed organizations may face limitation when using this API. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.edit_entitlements_license_extensions_projects_teams_etc_user_msa_backed_organizations_may_face_limitation_when_using_this_api
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlements_update_user_entitlement

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	JsonPatchDocument containing the operations to perform on the user.
`user_id`	string	yes	ID of the user.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

delete_user_from_account_delete_operation_includes_unassigning_extensions_and_licenses_and_removing_user_from_all_project_memberships_user_would_continue_have_access_account_if_she_is_member_aad_group_that_is_added_directly_account

Read

Delete a user from the account. The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId} (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.delete_user_from_account_delete_operation_includes_unassigning_extensions_and_licenses_and_removing_user_from_all_project_memberships_user_would_continue_have_access_account_if_she_is_member_aad_group_that_is_added_directly_account
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlements_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`user_id`	string	yes	ID of the user.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.5`.

get_summary_licenses_extension_projects_groups_and_their_assignments_collection Read

Get summary of Licenses, Extension, Projects, Groups and their assignments in the collection. Official Azure DevOps REST API 7.2 endpoint: GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlementsummary (spec: memberEntitlementManagement/7.2/memberEntitlementManagement.json).

Lua path: app.integrations.azure_devops.get_summary_licenses_extension_projects_groups_and_their_assignments_collection
Full name: azure-devops.azure_devops_member_entitlement_management_user_entitlement_summary_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`select`	string	no	Comma (",") separated list of properties to select. Supported property names are {AccessLevels, Licenses, Projects, Groups}.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_specified_user_settings_specified_subscription_this_api_is_typically_used_opt_or_out_shared_subscription_user_settings_can_only_be_applied_shared_subscriptions_like_team_subscriptions_or_default_subscriptions

Write

Update the specified user's settings for the specified subscription. This API is typically used to opt in or out of a shared subscription. User settings can only be applied to shared subscriptions, like team subscriptions or default subscriptions. Official Azure DevOps REST API 7.2 endpoint: PUT https://{service}dev.azure.com/{organization}/_apis/notification/Subscriptions/{subscriptionId}/usersettings/{userId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.update_specified_user_settings_specified_subscription_this_api_is_typically_used_opt_or_out_shared_subscription_user_settings_can_only_be_applied_shared_subscriptions_like_team_subscriptions_or_default_subscriptions
Full name: azure-devops.azure_devops_notification_subscriptions_update_subscription_user_settings

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subscription_id`	string	yes	path parameter `subscriptionId`.
`user_id`	string	yes	ID of the user
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_diagnostic_logs_this_service Read

Get a list of diagnostic logs for this service. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/diagnosticlogs/{source}/entries/{entryId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_list_diagnostic_logs_this_service
Full name: azure-devops.azure_devops_notification_diagnostic_logs_list

Parameter	Type	Required	Description
`source`	string	yes	ID specifying which type of logs to check diagnostics for.
`organization`	string	yes	The name of the Azure DevOps organization.
`entry_id`	string	yes	The ID of the specific log to query for.
`start_time`	string	no	Start time for the time range to query in.
`end_time`	string	no	End time for the time range to query in.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

list_available_event_types_this_service_optionally_filter_by_only_event_types_specified_publisher Read

List available event types for this service. Optionally filter by only event types for the specified publisher. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/eventtypes (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.list_available_event_types_this_service_optionally_filter_by_only_event_types_specified_publisher
Full name: azure-devops.azure_devops_notification_event_types_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`publisher_id`	string	no	Limit to event types for this publisher
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_event_type Read

Get a specific event type. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/eventtypes/{eventType} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_specific_event_type
Full name: azure-devops.azure_devops_notification_event_types_get

Parameter	Type	Required	Description
`event_type`	string	yes	The ID of the event type.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_notification_settings Read

GET /{organization}/_apis/notification/settings Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/settings (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_organization_apis_notification_settings
Full name: azure-devops.azure_devops_notification_settings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_apis_notification_settings Read

PATCH /{organization}/_apis/notification/settings Official Azure DevOps REST API 7.2 endpoint: PATCH https://{service}dev.azure.com/{organization}/_apis/notification/settings (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.patch_organization_apis_notification_settings
Full name: azure-devops.azure_devops_notification_settings_update

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_delivery_preferences_notifications_subscriber Read

Get delivery preferences of a notifications subscriber. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/subscribers/{subscriberId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_delivery_preferences_notifications_subscriber
Full name: azure-devops.azure_devops_notification_subscribers_get

Parameter	Type	Required	Description
`subscriber_id`	string	yes	ID of the user or group.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_delivery_preferences_notifications_subscriber Read

Update delivery preferences of a notifications subscriber. Official Azure DevOps REST API 7.2 endpoint: PATCH https://{service}dev.azure.com/{organization}/_apis/notification/subscribers/{subscriberId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.update_delivery_preferences_notifications_subscriber
Full name: azure-devops.azure_devops_notification_subscribers_update

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subscriber_id`	string	yes	ID of the user or group.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

query_subscriptions_subscription_is_returned_if_it_matches_one_or_more_specified_conditions Read

Query for subscriptions. A subscription is returned if it matches one or more of the specified conditions. Official Azure DevOps REST API 7.2 endpoint: POST https://{service}dev.azure.com/{organization}/_apis/notification/subscriptionquery (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.query_subscriptions_subscription_is_returned_if_it_matches_one_or_more_specified_conditions
Full name: azure-devops.azure_devops_notification_subscriptions_query

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_notification_subscriptions_either_by_subscription_ids_or_by_all_subscriptions_given_user_or_group Read

Get a list of notification subscriptions, either by subscription IDs or by all subscriptions for a given user or group. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_list_notification_subscriptions_either_by_subscription_ids_or_by_all_subscriptions_given_user_or_group
Full name: azure-devops.azure_devops_notification_subscriptions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`target_id`	string	no	User or Group ID
`ids`	string	no	List of subscription IDs
`query_flags`	string	no	query parameter `queryFlags`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_subscription Read

Create a new subscription. Official Azure DevOps REST API 7.2 endpoint: POST https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.create_new_subscription
Full name: azure-devops.azure_devops_notification_subscriptions_create

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_notification_subscription_by_its_id Read

Get a notification subscription by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions/{subscriptionId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_notification_subscription_by_its_id
Full name: azure-devops.azure_devops_notification_subscriptions_get

Parameter	Type	Required	Description
`subscription_id`	string	yes	path parameter `subscriptionId`.
`organization`	string	yes	The name of the Azure DevOps organization.
`query_flags`	string	no	query parameter `queryFlags`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_existing_subscription_depending_type_subscription_and_permissions_caller_can_update_description_filter_settings_channel_delivery_settings_and_more

Read

Update an existing subscription. Depending on the type of subscription and permissions, the caller can update the description, filter settings, channel (delivery) settings and more. Official Azure DevOps REST API 7.2 endpoint: PATCH https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions/{subscriptionId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.update_existing_subscription_depending_type_subscription_and_permissions_caller_can_update_description_filter_settings_channel_delivery_settings_and_more
Full name: azure-devops.azure_devops_notification_subscriptions_update

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subscription_id`	string	yes	path parameter `subscriptionId`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_subscription Read

Delete a subscription. Official Azure DevOps REST API 7.2 endpoint: DELETE https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions/{subscriptionId} (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.delete_subscription
Full name: azure-devops.azure_devops_notification_subscriptions_delete

Parameter	Type	Required	Description
`subscription_id`	string	yes	path parameter `subscriptionId`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_diagnostics_settings_subscription Read

Get the diagnostics settings for a subscription. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions/{subscriptionId}/diagnostics (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_diagnostics_settings_subscription
Full name: azure-devops.azure_devops_notification_diagnostics_get

Parameter	Type	Required	Description
`subscription_id`	string	yes	The id of the notifications subscription.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_diagnostics_settings_subscription Read

Update the diagnostics settings for a subscription. Official Azure DevOps REST API 7.2 endpoint: PUT https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions/{subscriptionId}/diagnostics (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.update_diagnostics_settings_subscription
Full name: azure-devops.azure_devops_notification_diagnostics_update

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`subscription_id`	string	yes	The id of the notifications subscription.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_available_subscription_templates Read

Get available subscription templates. Official Azure DevOps REST API 7.2 endpoint: GET https://{service}dev.azure.com/{organization}/_apis/notification/subscriptiontemplates (spec: notification/7.2/notification.json).

Lua path: app.integrations.azure_devops.get_available_subscription_templates
Full name: azure-devops.azure_devops_notification_subscriptions_get_subscription_templates

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_operation_from_operationid_using_given_pluginid_some_scenarios_don_t_require_pluginid_if_pluginid_is_not_included_call_then_just_operationid_will_be_used_find_operation

Read

Gets an operation from the operationId using the given pluginId. Some scenarios don’t require a pluginId. If a pluginId is not included in the call then just the operationId will be used to find an operation. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/operations/{operationId} (spec: operations/7.2/operations.json).

Lua path: app.integrations.azure_devops.gets_operation_from_operationid_using_given_pluginid_some_scenarios_don_t_require_pluginid_if_pluginid_is_not_included_call_then_just_operationid_will_be_used_find_operation
Full name: azure-devops.azure_devops_operations_operations_get

Parameter	Type	Required	Description
`operation_id`	string	yes	The ID for the operation.
`organization`	string	yes	The name of the Azure DevOps organization.
`plugin_id`	string	no	The ID for the plugin.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_permissions_reports Read

Get a list of permissions reports Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/permissionsreport (spec: permissionsReport/7.2/permissionsReport.json).

Lua path: app.integrations.azure_devops.get_list_permissions_reports
Full name: azure-devops.azure_devops_permissions_report_permissions_report_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

request_permissions_report_be_created_asyncronously Read

Request a permissions report to be created asyncronously Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/permissionsreport (spec: permissionsReport/7.2/permissionsReport.json).

Lua path: app.integrations.azure_devops.request_permissions_report_be_created_asyncronously
Full name: azure-devops.azure_devops_permissions_report_permissions_report_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request configuration to be included in the permissions report
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_permissions_report Read

Get a specific permissions report Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/permissionsreport/{id} (spec: permissionsReport/7.2/permissionsReport.json).

Lua path: app.integrations.azure_devops.get_specific_permissions_report
Full name: azure-devops.azure_devops_permissions_report_permissions_report_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	The ID (GUID) of the permissions report
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

download_json_results_permissions_report Read

Download the json results of a permissions report Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/permissionsreport/{id}/download (spec: permissionsReport/7.2/permissionsReport.json).

Lua path: app.integrations.azure_devops.download_json_results_permissions_report
Full name: azure-devops.azure_devops_permissions_report_permissions_report_download_download

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	The ID (GUID) of the permissions report
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_pipelines Read

Get a list of pipelines. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.get_list_pipelines
Full name: azure-devops.azure_devops_pipelines_pipelines_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`order_by`	string	no	A sort expression. Defaults to "name asc"
`top`	number	no	The maximum number of pipelines to return
`continuation_token`	string	no	A continuation token from a previous request, to retrieve the next page of results
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_pipeline Read

Create a pipeline. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.create_pipeline
Full name: azure-devops.azure_devops_pipelines_pipelines_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Input parameters.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_pipeline_optionally_at_specified_version Read

Gets a pipeline, optionally at the specified version Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId} (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.gets_pipeline_optionally_at_specified_version
Full name: azure-devops.azure_devops_pipelines_pipelines_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	The pipeline ID
`pipeline_version`	number	no	The pipeline version
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

queues_dry_run_pipeline_and_returns_object_containing_final_yaml Read

Queues a dry run of the pipeline and returns an object containing the final yaml. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/preview (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.queues_dry_run_pipeline_and_returns_object_containing_final_yaml
Full name: azure-devops.azure_devops_pipelines_preview_preview

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Optional additional parameters for this run.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	The pipeline ID.
`pipeline_version`	number	no	The pipeline version.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_top_10000_runs_particular_pipeline Read

Gets top 10000 runs for a particular pipeline. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.gets_top_10000_runs_particular_pipeline
Full name: azure-devops.azure_devops_pipelines_runs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	The pipeline id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

runs_pipeline Write

Runs a pipeline. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.runs_pipeline
Full name: azure-devops.azure_devops_pipelines_runs_run_pipeline

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Optional additional parameters for this run.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	The pipeline ID.
`pipeline_version`	number	no	The pipeline version.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_run_particular_pipeline Read

Gets a run for a particular pipeline. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId} (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.gets_run_particular_pipeline
Full name: azure-devops.azure_devops_pipelines_runs_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	The pipeline id
`run_id`	number	yes	The run id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_artifact_from_pipeline_run Read

Get a specific artifact from a pipeline run Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/artifacts (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.get_specific_artifact_from_pipeline_run
Full name: azure-devops.azure_devops_pipelines_artifacts_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	ID of the pipeline.
`run_id`	number	yes	ID of the run of that pipeline.
`artifact_name`	string	no	Name of the artifact.
`expand`	string	no	Expand options. Default is None.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_logs_from_pipeline_run Read

Get a list of logs from a pipeline run. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/logs (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.get_list_logs_from_pipeline_run
Full name: azure-devops.azure_devops_pipelines_logs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	ID of the pipeline.
`run_id`	number	yes	ID of the run of that pipeline.
`expand`	string	no	Expand options. Default is None.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_specific_log_from_pipeline_run Read

Get a specific log from a pipeline run Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/logs/{logId} (spec: pipelines/7.2/pipelines.json).

Lua path: app.integrations.azure_devops.get_specific_log_from_pipeline_run
Full name: azure-devops.azure_devops_pipelines_logs_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	yes	ID of the pipeline.
`run_id`	number	yes	ID of the run of that pipeline.
`log_id`	number	yes	ID of the log.
`expand`	string	no	Expand options. Default is None.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_policy_configurations_project_scope_parameter_this_api_should_not_be_used_except_legacy_compatability_reasons_it_returns_specifically_scoped_policies_and_does_not_support_heirarchical_nesting_instead_use_apis_git_policy_configurations_api_which_provides_first_class_scope_filtering_support_optional_policytype_parameter_can_be_used_filter_set_policies_returned_from_this_method

Read

Get a list of policy configurations in a project. The 'scope' parameter for this API should not be used, except for legacy compatability reasons. It returns specifically scoped policies and does not support heirarchical nesting. Instead, use the /_apis/git/policy/configurations API, which provides first class scope filtering support. The optional `policyType` parameter can be used to filter the set of policies returned from this method. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.get_list_policy_configurations_project_scope_parameter_this_api_should_not_be_used_except_legacy_compatability_reasons_it_returns_specifically_scoped_policies_and_does_not_support_heirarchical_nesting_instead_use_apis_git_policy_configurations_api_which_provides_first_class_scope_filtering_support_optional_policytype_parameter_can_be_used_filter_set_policies_returned_from_this_method
Full name: azure-devops.azure_devops_policy_configurations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`scope`	string	no	[Provided for legacy reasons] The scope on which a subset of policies is defined.
`top`	number	no	Maximum number of policies to return.
`continuation_token`	string	no	The continuation token used for pagination.
`policy_type`	string	no	Filter returned policies to only this type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_policy_configuration_given_policy_type Read

Create a policy configuration of a given policy type. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/policy/configurations (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.create_policy_configuration_given_policy_type
Full name: azure-devops.azure_devops_policy_configurations_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The policy configuration to create.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_policy_configuration_by_its_id Read

Get a policy configuration by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.get_policy_configuration_by_its_id
Full name: azure-devops.azure_devops_policy_configurations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`configuration_id`	number	yes	ID of the policy configuration
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_policy_configuration_by_its_id Read

Update a policy configuration by its ID. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.update_policy_configuration_by_its_id
Full name: azure-devops.azure_devops_policy_configurations_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The policy configuration to update.
`project`	string	yes	Project ID or project name
`configuration_id`	number	yes	ID of the existing policy configuration to be updated.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_policy_configuration_by_its_id Read

Delete a policy configuration by its ID. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.delete_policy_configuration_by_its_id
Full name: azure-devops.azure_devops_policy_configurations_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`configuration_id`	number	yes	ID of the policy configuration to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_all_revisions_given_policy Read

Retrieve all revisions for a given policy. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId}/revisions (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.retrieve_all_revisions_given_policy
Full name: azure-devops.azure_devops_policy_revisions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`configuration_id`	number	yes	The policy configuration ID.
`top`	number	no	The number of revisions to retrieve.
`skip`	number	no	The number of revisions to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_specific_revision_given_policy_by_id Read

Retrieve a specific revision of a given policy by ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId}/revisions/{revisionId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.retrieve_specific_revision_given_policy_by_id
Full name: azure-devops.azure_devops_policy_revisions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`configuration_id`	number	yes	The policy configuration ID.
`revision_id`	number	yes	The revision ID.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieves_list_all_policy_evaluation_statuses_specific_pull_request_evaluations_are_retrieved_using_artifact_id_which_uniquely_identifies_pull_request_generate_artifact_id_pull_request_use_this_template_vstfs_codereview_codereviewid_projectid_pullrequestid

Read

Retrieves a list of all the policy evaluation statuses for a specific pull request. Evaluations are retrieved using an artifact ID which uniquely identifies the pull request. To generate an artifact ID for a pull request, use this template: ``` vstfs:///CodeReview/CodeReviewId/{projectId}/{pullRequestId} ``` Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/evaluations (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.retrieves_list_all_policy_evaluation_statuses_specific_pull_request_evaluations_are_retrieved_using_artifact_id_which_uniquely_identifies_pull_request_generate_artifact_id_pull_request_use_this_template_vstfs_codereview_codereviewid_projectid_pullrequestid
Full name: azure-devops.azure_devops_policy_evaluations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`artifact_id`	string	no	A string which uniquely identifies the target of a policy evaluation.
`include_not_applicable`	boolean	no	Some policies might determine that they do not apply to a specific pull request. Setting this parameter to true will return evaluation records even for policies which don't apply to this pull request.
`top`	number	no	The number of policy evaluation records to retrieve.
`skip`	number	no	The number of policy evaluation records to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_present_evaluation_state_policy_each_policy_which_applies_pull_request_will_have_evaluation_state_which_is_specific_that_policy_running_context_that_pull_request_each_evaluation_is_uniquely_identified_via_guid_you_can_find_all_policy_evaluations_specific_pull_request_using_list_operation_this_controller

Read

Gets the present evaluation state of a policy. Each policy which applies to a pull request will have an evaluation state which is specific to that policy running in the context of that pull request. Each evaluation is uniquely identified via a Guid. You can find all the policy evaluations for a specific pull request using the List operation of this controller. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/evaluations/{evaluationId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.gets_present_evaluation_state_policy_each_policy_which_applies_pull_request_will_have_evaluation_state_which_is_specific_that_policy_running_context_that_pull_request_each_evaluation_is_uniquely_identified_via_guid_you_can_find_all_policy_evaluations_specific_pull_request_using_list_operation_this_controller
Full name: azure-devops.azure_devops_policy_evaluations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`evaluation_id`	string	yes	ID of the policy evaluation to be retrieved.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

requeue_policy_evaluation_some_policies_define_requeue_action_which_performs_some_policy_specific_operation_you_can_trigger_this_operation_by_updating_existing_policy_evaluation_and_setting_policyevaluationrecord_status_field_queued_although_any_policy_evaluation_can_be_requeued_at_present_only_build_policies_perform_any_action_response_requeueing_build_policy_will_queue_new_build_run_cancelling_any_existing_build_which_is_running

Read

Requeue the policy evaluation. Some policies define a "requeue" action which performs some policy-specific operation. You can trigger this operation by updating an existing policy evaluation and setting the PolicyEvaluationRecord.Status field to Queued. Although any policy evaluation can be requeued, at present only build policies perform any action in response. Requeueing a build policy will queue a new build to run (cancelling any existing build which is running). Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/policy/evaluations/{evaluationId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.requeue_policy_evaluation_some_policies_define_requeue_action_which_performs_some_policy_specific_operation_you_can_trigger_this_operation_by_updating_existing_policy_evaluation_and_setting_policyevaluationrecord_status_field_queued_although_any_policy_evaluation_can_be_requeued_at_present_only_build_policies_perform_any_action_response_requeueing_build_policy_will_queue_new_build_run_cancelling_any_existing_build_which_is_running
Full name: azure-devops.azure_devops_policy_evaluations_requeue_policy_evaluation

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`evaluation_id`	string	yes	ID of the policy evaluation to be retrieved.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

retrieve_all_available_policy_types Read

Retrieve all available policy types. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/types (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.retrieve_all_available_policy_types
Full name: azure-devops.azure_devops_policy_types_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_specific_policy_type_by_id Read

Retrieve a specific policy type by ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/policy/types/{typeId} (spec: policy/7.2/policy.json).

Lua path: app.integrations.azure_devops.retrieve_specific_policy_type_by_id
Full name: azure-devops.azure_devops_policy_types_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type_id`	string	yes	The policy ID.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_requested_process_template Read

Returns requested process template. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processadmin/processes/export/{id} (spec: processadmin/7.2/workItemTrackingProcessTemplate.json).

Lua path: app.integrations.azure_devops.returns_requested_process_template
Full name: azure-devops.azure_devops_processadmin_processes_export_process_template

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	The ID of the process
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

imports_process_from_zip_file Read

Imports a process from zip file. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processadmin/processes/import (spec: processadmin/7.2/workItemTrackingProcessTemplate.json).

Lua path: app.integrations.azure_devops.imports_process_from_zip_file
Full name: azure-devops.azure_devops_processadmin_processes_import_process_template

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Raw payload: provide `content` as a string and optional `content_type`.
`ignore_warnings`	boolean	no	Ignores validation warnings. Default value is false.
`replace_existing_template`	boolean	no	Replaces the existing template. Default value is true.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

tells_whether_promote_has_completed_specified_promote_job_id Read

Tells whether promote has completed for the specified promote job ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processadmin/processes/status/{id} (spec: processadmin/7.2/workItemTrackingProcessTemplate.json).

Lua path: app.integrations.azure_devops.tells_whether_promote_has_completed_specified_promote_job_id
Full name: azure-devops.azure_devops_processadmin_processes_import_process_template_status

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	The ID of the promote job operation
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_behaviors_process Read

Returns a list of behaviors for the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processadmin/{processId}/behaviors (spec: processadmin/7.2/workItemTrackingProcessTemplate.json).

Lua path: app.integrations.azure_devops.returns_list_behaviors_process
Full name: azure-devops.azure_devops_processadmin_behaviors_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_all_processes_including_system_and_inherited Read

Get list of all processes including system and inherited. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.get_list_all_processes_including_system_and_inherited
Full name: azure-devops.azure_devops_processes_processes_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_process Read

Creates a process. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.creates_process
Full name: azure-devops.azure_devops_processes_processes_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	CreateProcessModel.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_meta_data_picklist Read

Returns meta data of the picklist. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/lists (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_meta_data_picklist
Full name: azure-devops.azure_devops_processes_lists_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_picklist Read

Creates a picklist. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/lists (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.creates_picklist
Full name: azure-devops.azure_devops_processes_lists_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Picklist
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_picklist Read

Returns a picklist. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/lists/{listId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_picklist
Full name: azure-devops.azure_devops_processes_lists_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`list_id`	string	yes	The ID of the list
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_list Read

Updates a list. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/work/processes/lists/{listId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_list
Full name: azure-devops.azure_devops_processes_lists_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`list_id`	string	yes	The ID of the list
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_picklist Read

Removes a picklist. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/lists/{listId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_picklist
Full name: azure-devops.azure_devops_processes_lists_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`list_id`	string	yes	The ID of the list
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_all_behaviors_process Read

Returns a list of all behaviors in the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_list_all_behaviors_process
Full name: azure-devops.azure_devops_processes_behaviors_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_single_behavior_given_process Read

Creates a single behavior in the given process. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.creates_single_behavior_given_process
Full name: azure-devops.azure_devops_processes_behaviors_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_behavior_process Read

Returns a behavior of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors/{behaviorRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_behavior_process
Full name: azure-devops.azure_devops_processes_behaviors_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`behavior_ref_name`	string	yes	The reference name of the behavior
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

replaces_behavior_process Read

Replaces a behavior in the process. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors/{behaviorRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.replaces_behavior_process
Full name: azure-devops.azure_devops_processes_behaviors_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`behavior_ref_name`	string	yes	The reference name of the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_behavior_process Read

Removes a behavior in the process. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/behaviors/{behaviorRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_behavior_process
Full name: azure-devops.azure_devops_processes_behaviors_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`behavior_ref_name`	string	yes	The reference name of the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_list_all_fields_work_item_type Read

Returns a list of all fields in a work item type. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_list_all_fields_work_item_type
Full name: azure-devops.azure_devops_processes_fields_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

adds_field_work_item_type Read

Adds a field to a work item type. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.adds_field_work_item_type
Full name: azure-devops.azure_devops_processes_fields_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_field_work_item_type Read

Returns a field in a work item type. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields/{fieldRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_field_work_item_type
Full name: azure-devops.azure_devops_processes_fields_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`field_ref_name`	string	yes	The reference name of the field.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_field_work_item_type Read

Updates a field in a work item type. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields/{fieldRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_field_work_item_type
Full name: azure-devops.azure_devops_processes_fields_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`field_ref_name`	string	yes	The reference name of the field.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_field_from_work_item_type_does_not_permanently_delete_field Write

Removes a field from a work item type. Does not permanently delete the field. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields/{fieldRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_field_from_work_item_type_does_not_permanently_delete_field
Full name: azure-devops.azure_devops_processes_fields_remove_work_item_type_field

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`field_ref_name`	string	yes	The reference name of the field.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_form_layout Read

Gets the form layout. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.gets_form_layout
Full name: azure-devops.azure_devops_processes_layout_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_control_group Read

Creates a control in a group. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.creates_control_group
Full name: azure-devops.azure_devops_processes_controls_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The control.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`group_id`	string	yes	The ID of the group to add the control to.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

moves_control_specified_group Write

Moves a control to a specified group. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls/{controlId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.moves_control_specified_group
Full name: azure-devops.azure_devops_processes_controls_move_control_to_group

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The control.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`group_id`	string	yes	The ID of the group to move the control to.
`control_id`	string	yes	The ID of the control.
`remove_from_group_id`	string	no	The group ID to remove the control from.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_control_work_item_form Read

Updates a control on the work item form. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls/{controlId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_control_work_item_form
Full name: azure-devops.azure_devops_processes_controls_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The updated control.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`group_id`	string	yes	The ID of the group.
`control_id`	string	yes	The ID of the control.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_control_from_work_item_form Write

Removes a control from the work item form. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls/{controlId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_control_from_work_item_form
Full name: azure-devops.azure_devops_processes_controls_remove_control_from_group

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`group_id`	string	yes	The ID of the group.
`control_id`	string	yes	The ID of the control to remove.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

adds_page_work_item_form Read

Adds a page to the work item form. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.adds_page_work_item_form
Full name: azure-devops.azure_devops_processes_pages_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The page.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_page_work_item_form Read

Updates a page on the work item form Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_page_work_item_form
Full name: azure-devops.azure_devops_processes_pages_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The page
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_page_from_work_item_form Write

Removes a page from the work item form Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages/{pageId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_page_from_work_item_form
Full name: azure-devops.azure_devops_processes_pages_remove_page

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`page_id`	string	yes	The ID of the page
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

adds_group_work_item_form Read

Adds a group to the work item form. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages/{pageId}/sections/{sectionId}/groups (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.adds_group_work_item_form
Full name: azure-devops.azure_devops_processes_groups_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The group.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`page_id`	string	yes	The ID of the page to add the group to.
`section_id`	string	yes	The ID of the section to add the group to.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

moves_group_different_section Write

Moves a group to a different section. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages/{pageId}/sections/{sectionId}/groups/{groupId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.moves_group_different_section
Full name: azure-devops.azure_devops_processes_groups_move_group_to_section

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The updated group.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`page_id`	string	yes	The ID of the page the group is in.
`section_id`	string	yes	The ID of the section the group is in.
`group_id`	string	yes	The ID of the group.
`remove_from_section_id`	string	no	ID of the section to remove the group from.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_group_work_item_form Read

Updates a group in the work item form. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages/{pageId}/sections/{sectionId}/groups/{groupId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_group_work_item_form
Full name: azure-devops.azure_devops_processes_groups_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The updated group.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`page_id`	string	yes	The ID of the page the group is in.
`section_id`	string	yes	The ID of the section the group is in.
`group_id`	string	yes	The ID of the group.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_group_from_work_item_form Write

Removes a group from the work item form. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/pages/{pageId}/sections/{sectionId}/groups/{groupId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_group_from_work_item_form
Full name: azure-devops.azure_devops_processes_groups_remove_group

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`page_id`	string	yes	The ID of the page the group is in
`section_id`	string	yes	The ID of the section to the group is in
`group_id`	string	yes	The ID of the group
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_edited_system_controls_work_item_type_process_get_all_system_controls_base_edited_use_layout_api Read

Gets edited system controls for a work item type in a process. To get all system controls (base + edited) use layout API(s) Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/systemcontrols (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.gets_edited_system_controls_work_item_type_process_get_all_system_controls_base_edited_use_layout_api
Full name: azure-devops.azure_devops_processes_system_controls_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_adds_system_control_work_item_form Read

Updates/adds a system control on the work item form. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/systemcontrols/{controlId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_adds_system_control_work_item_form
Full name: azure-devops.azure_devops_processes_system_controls_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`control_id`	string	yes	The ID of the control.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_system_control_modification_work_item_form Read

Deletes a system control modification on the work item form. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/systemcontrols/{controlId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.deletes_system_control_modification_work_item_form
Full name: azure-devops.azure_devops_processes_system_controls_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`control_id`	string	yes	The ID of the control.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_all_rules_work_item_type_process Read

Returns a list of all rules in the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_list_all_rules_work_item_type_process
Full name: azure-devops.azure_devops_processes_rules_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

adds_rule_work_item_type_process Read

Adds a rule to work item type in the process. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.adds_rule_work_item_type_process
Full name: azure-devops.azure_devops_processes_rules_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_single_rule_work_item_type_process Read

Returns a single rule in the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules/{ruleId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_single_rule_work_item_type_process
Full name: azure-devops.azure_devops_processes_rules_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`rule_id`	string	yes	The ID of the rule
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_rule_work_item_type_process Read

Updates a rule in the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules/{ruleId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_rule_work_item_type_process
Full name: azure-devops.azure_devops_processes_rules_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`rule_id`	string	yes	The ID of the rule
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_rule_from_work_item_type_process Read

Removes a rule from the work item type in the process. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules/{ruleId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_rule_from_work_item_type_process
Full name: azure-devops.azure_devops_processes_rules_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`rule_id`	string	yes	The ID of the rule
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_list_all_state_definitions_work_item_type_process Read

Returns a list of all state definitions in a work item type of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_list_all_state_definitions_work_item_type_process
Full name: azure-devops.azure_devops_processes_states_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_state_definition_work_item_type_process Read

Creates a state definition in the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.creates_state_definition_work_item_type_process
Full name: azure-devops.azure_devops_processes_states_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_single_state_definition_work_item_type_process Read

Returns a single state definition in a work item type of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_single_state_definition_work_item_type_process
Full name: azure-devops.azure_devops_processes_states_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`state_id`	string	yes	The ID of the state
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

hides_state_definition_work_item_type_process_only_states_with_customizationtype_system_can_be_hidden Read

Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.hides_state_definition_work_item_type_process_only_states_with_customizationtype_system_can_be_hidden
Full name: azure-devops.azure_devops_processes_states_hide_state_definition

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`state_id`	string	yes	The ID of the state
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_given_state_definition_work_item_type_process Read

Updates a given state definition in the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_given_state_definition_work_item_type_process
Full name: azure-devops.azure_devops_processes_states_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`state_id`	string	yes	ID of the state
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_state_definition_work_item_type_process Read

Removes a state definition in the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_state_definition_work_item_type_process
Full name: azure-devops.azure_devops_processes_states_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`state_id`	string	yes	ID of the state
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_all_work_item_types_process Read

Returns a list of all work item types in a process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_list_all_work_item_types_process
Full name: azure-devops.azure_devops_processes_work_item_types_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`expand`	string	no	Flag to determine what properties of work item type to return
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_work_item_type_process Read

Creates a work item type in the process. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.creates_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process on which to create work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_single_work_item_type_process Read

Returns a single work item type in a process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_single_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`expand`	string	no	Flag to determine what properties of work item type to return
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_work_item_type_process Read

Updates a work item type of the process. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name`	string	yes	The reference name of the work item type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_work_item_type_process Read

Removes a work item type in the process. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process.
`wit_ref_name`	string	yes	The reference name of the work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_list_all_behaviors_work_item_type_process Read

Returns a list of all behaviors for the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{witRefNameForBehaviors}/behaviors (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_list_all_behaviors_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_behaviors_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name_for_behaviors`	string	yes	Work item type reference name for the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

adds_behavior_work_item_type_process Read

Adds a behavior to the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{witRefNameForBehaviors}/behaviors (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.adds_behavior_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_behaviors_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name_for_behaviors`	string	yes	Work item type reference name for the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_behavior_work_item_type_process Read

Updates a behavior for the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{witRefNameForBehaviors}/behaviors (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.updates_behavior_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_behaviors_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_id`	string	yes	The ID of the process
`wit_ref_name_for_behaviors`	string	yes	Work item type reference name for the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_behavior_work_item_type_process Read

Returns a behavior for the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{witRefNameForBehaviors}/behaviors/{behaviorRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.returns_behavior_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_behaviors_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name_for_behaviors`	string	yes	Work item type reference name for the behavior
`behavior_ref_name`	string	yes	The reference name of the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

removes_behavior_work_item_type_process Write

Removes a behavior for the work item type of the process. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypesbehaviors/{witRefNameForBehaviors}/behaviors/{behaviorRefName} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_behavior_work_item_type_process
Full name: azure-devops.azure_devops_processes_work_item_types_behaviors_remove_behavior_from_work_item_type

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_id`	string	yes	The ID of the process
`wit_ref_name_for_behaviors`	string	yes	Work item type reference name for the behavior
`behavior_ref_name`	string	yes	The reference name of the behavior
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_single_process_specified_id Read

Get a single process of a specified ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.get_single_process_specified_id
Full name: azure-devops.azure_devops_processes_processes_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_type_id`	string	yes	path parameter `processTypeId`.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

edit_process_specific_id Read

Edit a process of a specific ID. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.edit_process_specific_id
Full name: azure-devops.azure_devops_processes_processes_edit_process

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`process_type_id`	string	yes	path parameter `processTypeId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_process_specific_id Read

Removes a process of a specific ID. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId} (spec: processes/7.2/workItemTrackingProcess.json).

Lua path: app.integrations.azure_devops.removes_process_specific_id
Full name: azure-devops.azure_devops_processes_processes_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`process_type_id`	string	yes	path parameter `processTypeId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_user_profile Read

Gets a user profile. Official Azure DevOps REST API 7.2 endpoint: GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id} (spec: profile/7.2/profile.json).

Lua path: app.integrations.azure_devops.gets_user_profile
Full name: azure-devops.azure_devops_profile_profiles_get

Parameter	Type	Required	Description
`id`	string	yes	The ID of the target user profile within the same organization, or 'me' to get the profile of the current authenticated user.
`details`	boolean	no	Return public profile information such as display name, email address, country, etc. If false, the withAttributes parameter is ignored.
`with_attributes`	boolean	no	If true, gets the attributes (named key-value pairs of arbitrary data) associated with the profile. The partition parameter must also have a value.
`partition`	string	no	The partition (named group) of attributes to return.
`core_attributes`	string	no	A comma-delimited list of core profile attributes to return. Valid values are Email, Avatar, DisplayName, and ContactWithOffers.
`force_refresh`	boolean	no	Not used in this version of the API.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_revision_history_release_definition Read

Get revision history for a release definition Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/definitions/{definitionId}/revisions (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_revision_history_release_definition
Full name: azure-devops.azure_devops_release_definitions_get_release_definition_history

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	Id of the definition.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_release_definition_given_definitionid_and_revision Read

Get release definition for a given definitionId and revision Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/definitions/{definitionId}/revisions/{revision} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_release_definition_given_definitionid_and_revision
Full name: azure-devops.azure_devops_release_definitions_get_definition_revision

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	Id of the definition.
`revision`	number	yes	Id of the revision.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_release_environment Read

Get a release environment. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_release_environment
Full name: azure-devops.azure_devops_release_releases_get_release_environment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of the release environment.
`expand`	string	no	A property that should be expanded in the environment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

update_status_release_environment Write

Update the status of a release environment Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.update_status_release_environment
Full name: azure-devops.azure_devops_release_releases_update_release_environment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Environment update meta data.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of release environment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.8`.

list_all_manual_interventions_given_release Read

List all manual interventions for a given release. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.list_all_manual_interventions_given_release
Full name: azure-devops.azure_devops_release_manual_interventions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_manual_intervention_given_release_and_manual_intervention_id Read

Get manual intervention for a given release and manual intervention id. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_manual_intervention_given_release_and_manual_intervention_id
Full name: azure-devops.azure_devops_release_manual_interventions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`manual_intervention_id`	number	yes	Id of the manual intervention.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_manual_intervention Read

Update manual intervention. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.update_manual_intervention
Full name: azure-devops.azure_devops_release_manual_interventions_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Meta data to update manual intervention.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`manual_intervention_id`	number	yes	Id of the manual intervention.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_approvals Read

Get a list of approvals Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_list_approvals
Full name: azure-devops.azure_devops_release_approvals_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`assigned_to_filter`	string	no	Approvals assigned to this user.
`status_filter`	string	no	Approvals with this status. Default is 'pending'.
`release_ids_filter`	string	no	Approvals for release id(s) mentioned in the filter. Multiple releases can be mentioned by separating them with ',' e.g. releaseIdsFilter=1,2,3,4.
`type_filter`	string	no	Approval with this type.
`top`	number	no	Number of approvals to get. Default is 50.
`continuation_token`	number	no	Gets the approvals after the continuation token provided.
`query_order`	string	no	Gets the results in the defined order of created approvals. Default is 'descending'.
`include_my_group_approvals`	boolean	no	'true' to include my group approvals. Default is 'false'.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_status_approval Read

Update status of an approval Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals/{approvalId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.update_status_approval
Full name: azure-devops.azure_devops_release_approvals_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	ReleaseApproval object having status, approver and comments.
`project`	string	yes	Project ID or project name
`approval_id`	number	yes	Id of the approval.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_list_release_definitions Read

Get a list of release definitions. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_list_release_definitions
Full name: azure-devops.azure_devops_release_definitions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`search_text`	string	no	Get release definitions with names containing searchText.
`expand`	string	no	The properties that should be expanded in the list of Release definitions.
`artifact_type`	string	no	Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
`artifact_source_id`	string	no	Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
`top`	number	no	Number of release definitions to get.
`continuation_token`	string	no	Gets the release definitions after the continuation token provided.
`query_order`	string	no	Gets the results in the defined order. Default is 'IdAscending'.
`path`	string	no	Gets the release definitions under the specified path.
`is_exact_name_match`	boolean	no	'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
`tag_filter`	string	no	A comma-delimited list of tags. Only release definitions with these tags will be returned.
`property_filters`	string	no	A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definitions will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release Definition from results irrespective of whether it has property set or not.
`definition_id_filter`	string	no	A comma-delimited list of release definitions to retrieve.
`is_deleted`	boolean	no	'true' to get release definitions that has been deleted. Default is 'false'
`search_text_contains_folder_name`	boolean	no	'true' to get the release definitions under the folder with name as specified in searchText. Default is 'false'.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

create_release_definition Read

Create a release definition Official Azure DevOps REST API 7.2 endpoint: POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.create_release_definition
Full name: azure-devops.azure_devops_release_definitions_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	release definition object to create.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

update_release_definition Read

Update a release definition. Official Azure DevOps REST API 7.2 endpoint: PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.update_release_definition
Full name: azure-devops.azure_devops_release_definitions_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Release definition object to update.
`project`	string	yes	Project ID or project name
`skip_tasks_validation`	boolean	no	Skip task validation boolean flag
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_release_definition Read

Get a release definition. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_release_definition
Full name: azure-devops.azure_devops_release_definitions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	Id of the release definition.
`property_filters`	string	no	A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definition will contain values for the specified property Ids (if they exist). If not set, properties will not be included.
`include_disabled`	boolean	no	Boolean flag to include disabled definitions.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

delete_release_definition Read

Delete a release definition. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.delete_release_definition
Full name: azure-devops.azure_devops_release_definitions_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	yes	Id of the release definition.
`comment`	string	no	Comment for deleting a release definition.
`force_delete`	boolean	no	'true' to automatically cancel any in-progress release deployments and proceed with release definition deletion . Default is 'false'.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_list_deployments Read

Get a list of deployments Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/deployments (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_list_deployments
Full name: azure-devops.azure_devops_release_deployments_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	no	List the deployments for a given definition id.
`definition_environment_id`	number	no	List the deployments for a given definition environment id.
`created_by`	string	no	List the deployments for which deployments are created as identity specified.
`min_modified_time`	string	no	List the deployments with LastModified time >= minModifiedTime.
`max_modified_time`	string	no	List the deployments with LastModified time <= maxModifiedTime.
`deployment_status`	string	no	List the deployments with given deployment status. Default is 'All'.
`operation_status`	string	no	List the deployments with given operation status. Default is 'All'.
`latest_attempts_only`	boolean	no	'true' to include deployments with latest attempt only. Default is 'false'.
`query_order`	string	no	List the deployments with given query order. Default is 'Descending'.
`top`	number	no	List the deployments with given top. Default top is '50' and Max top is '100'.
`continuation_token`	number	no	List the deployments with deployment id >= continuationToken.
`created_for`	string	no	List the deployments for which deployments are requested as identity specified.
`min_started_time`	string	no	List the deployments with StartedOn time >= minStartedTime.
`max_started_time`	string	no	List the deployments with StartedOn time <= maxStartedTime.
`source_branch`	string	no	List the deployments that are deployed from given branch name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_folders Read

Gets folders. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.gets_folders
Full name: azure-devops.azure_devops_release_folders_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`path`	string	yes	Path of the folder.
`query_order`	string	no	Gets the results in the defined order. Default is 'None'.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

this_method_is_no_longer_supported_use_createfolder_with_folder_parameter_api Read

This method is no longer supported. Use CreateFolder with folder parameter API. Official Azure DevOps REST API 7.2 endpoint: POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.this_method_is_no_longer_supported_use_createfolder_with_folder_parameter_api
Full name: azure-devops.azure_devops_release_folders_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	folder.
`project`	string	yes	Project ID or project name
`path`	string	yes	Path of the folder.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_existing_folder_at_given_existing_path Read

Updates an existing folder at given existing path. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.updates_existing_folder_at_given_existing_path
Full name: azure-devops.azure_devops_release_folders_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	folder.
`project`	string	yes	Project ID or project name
`path`	string	yes	Path of the folder to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

deletes_definition_folder_given_folder_name_and_path_and_all_it_existing_definitions Read

Deletes a definition folder for given folder name and path and all it's existing definitions. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.deletes_definition_folder_given_folder_name_and_path_and_all_it_existing_definitions
Full name: azure-devops.azure_devops_release_folders_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`path`	string	yes	Path of the folder to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_gate_deployment Read

Updates the gate for a deployment. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/gates/{gateStepId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.updates_gate_deployment
Full name: azure-devops.azure_devops_release_gates_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Metadata to patch the Release Gates.
`project`	string	yes	Project ID or project name
`gate_step_id`	number	yes	Gate step Id.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_releases Read

Get a list of releases Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_list_releases
Full name: azure-devops.azure_devops_release_releases_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition_id`	number	no	Releases from this release definition Id.
`definition_environment_id`	number	no	query parameter `definitionEnvironmentId`.
`search_text`	string	no	Releases with names containing searchText.
`created_by`	string	no	Releases created by this user.
`status_filter`	string	no	Releases that have this status.
`environment_status_filter`	number	no	query parameter `environmentStatusFilter`.
`min_created_time`	string	no	Releases that were created after this time.
`max_created_time`	string	no	Releases that were created before this time.
`query_order`	string	no	Gets the results in the defined order of created date for releases. Default is descending.
`top`	number	no	Number of releases to get. Default is 50.
`continuation_token`	number	no	Gets the releases after the continuation token provided.
`expand`	string	no	The property that should be expanded in the list of releases.
`artifact_type_id`	string	no	Releases with given artifactTypeId will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
`source_id`	string	no	Unique identifier of the artifact used. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
`artifact_version_id`	string	no	Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId.
`source_branch_filter`	string	no	Releases with given sourceBranchFilter will be returned (Not to be used with environmentStatusFilter).
`is_deleted`	boolean	no	Gets the soft deleted releases, if true.
`tag_filter`	string	no	A comma-delimited list of tags. Only releases with these tags will be returned.
`property_filters`	string	no	A comma-delimited list of extended properties to be retrieved. If set, the returned Releases will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release from results irrespective of whether it has property set or not.
`release_id_filter`	string	no	A comma-delimited list of releases Ids. Only releases with these Ids will be returned.
`path`	string	no	Releases under this folder path will be returned
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.9`.

create_release Read

Create a release. Official Azure DevOps REST API 7.2 endpoint: POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.create_release
Full name: azure-devops.azure_devops_release_releases_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Metadata to create a release.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.9`.

get_release_given_revision_number Read

Get release for a given revision number. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_release_given_revision_number
Full name: azure-devops.azure_devops_release_releases_get_release_revision

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`definition_snapshot_revision`	number	no	Definition snapshot revision number.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.9`.

update_complete_release_object Write

Update a complete release object. Official Azure DevOps REST API 7.2 endpoint: PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.update_complete_release_object
Full name: azure-devops.azure_devops_release_releases_update_release

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Release object for update.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.9`.

update_few_properties_release Write

Update few properties of a release. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.update_few_properties_release
Full name: azure-devops.azure_devops_release_releases_update_release_resource

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Properties of release to update.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.9`.

get_release_task_attachments Read

Get the release task attachments. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/plan/{planId}/attachments/{type} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_release_task_attachments
Full name: azure-devops.azure_devops_release_attachments_get_release_task_attachments

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of the release environment.
`attempt_id`	number	yes	Attempt number of deployment.
`plan_id`	string	yes	Plan Id of the deploy phase.
`type`	string	yes	Type of the attachment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_release_task_attachment Read

Get a release task attachment. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/plan/{planId}/timelines/{timelineId}/records/{recordId}/attachments/{type}/{name} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_release_task_attachment
Full name: azure-devops.azure_devops_release_attachments_get_release_task_attachment_content

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of the release environment.
`attempt_id`	number	yes	Attempt number of deployment.
`plan_id`	string	yes	Plan Id of the deploy phase.
`timeline_id`	string	yes	Timeline Id of the task.
`record_id`	string	yes	Record Id of attachment.
`type`	string	yes	Type of the attachment.
`name`	string	yes	Name of the attachment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gettaskattachments_api_is_deprecated_use_getreleasetaskattachments_api_instead Read

GetTaskAttachments API is deprecated. Use GetReleaseTaskAttachments API instead. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/timelines/{timelineId}/attachments/{type} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.gettaskattachments_api_is_deprecated_use_getreleasetaskattachments_api_instead
Full name: azure-devops.azure_devops_release_attachments_get_task_attachments

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of the release environment.
`attempt_id`	number	yes	Attempt number of deployment.
`timeline_id`	string	yes	Timeline Id of the task.
`type`	string	yes	Type of the attachment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gettaskattachmentcontent_api_is_deprecated_use_getreleasetaskattachmentcontent_api_instead Read

GetTaskAttachmentContent API is deprecated. Use GetReleaseTaskAttachmentContent API instead. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/timelines/{timelineId}/records/{recordId}/attachments/{type}/{name} (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.gettaskattachmentcontent_api_is_deprecated_use_getreleasetaskattachmentcontent_api_instead
Full name: azure-devops.azure_devops_release_attachments_get_task_attachment_content

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of the release environment.
`attempt_id`	number	yes	Attempt number of deployment.
`timeline_id`	string	yes	Timeline Id of the task.
`record_id`	string	yes	Record Id of attachment.
`type`	string	yes	Type of the attachment.
`name`	string	yes	Name of the attachment.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_task_log_release_plain_text_file Read

Gets the task log of a release as a plain text file. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/deployPhases/{releaseDeployPhaseId}/tasks/{taskId}/logs (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.gets_task_log_release_plain_text_file
Full name: azure-devops.azure_devops_release_releases_get_task_log

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`environment_id`	number	yes	Id of release environment.
`release_deploy_phase_id`	number	yes	Release deploy phase Id.
`task_id`	number	yes	ReleaseTask Id for the log.
`start_line`	number	no	Starting line number for logs
`end_line`	number	no	Ending line number for logs
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_logs_release_id Read

Get logs for a release Id. Official Azure DevOps REST API 7.2 endpoint: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/logs (spec: release/7.2/release.json).

Lua path: app.integrations.azure_devops.get_logs_release_id
Full name: azure-devops.azure_devops_release_releases_get_logs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	yes	Id of the release.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_apis_resourceusage Read

GET /{organization}/_apis/resourceusage Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/resourceusage (spec: resourceUsage/7.2/resourceUsage.json).

Lua path: app.integrations.azure_devops.get_organization_apis_resourceusage
Full name: azure-devops.azure_devops_resource_usage_team_project_collection_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.1-preview.1`.

gets_project_level_limits_and_usage_project Read

Gets the Project Level limits and Usage for a project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/resourceusage (spec: resourceUsage/7.2/resourceUsage.json).

Lua path: app.integrations.azure_devops.gets_project_level_limits_and_usage_project
Full name: azure-devops.azure_devops_resource_usage_project_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.1-preview.1`.

provides_set_results_search_text Read

Provides a set of results for the search text. Official Azure DevOps REST API 7.2 endpoint: POST https://almsearch.dev.azure.com/{organization}/_apis/search/packagesearchresults (spec: search/7.2/search.json).

Lua path: app.integrations.azure_devops.provides_set_results_search_text
Full name: azure-devops.azure_devops_search_package_search_results_fetch_package_search_results

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The Package Search Request.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

provides_set_results_search_text Read

Provides a set of results for the search text. Official Azure DevOps REST API 7.2 endpoint: POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/codesearchresults (spec: search/7.2/search.json).

Lua path: app.integrations.azure_devops.provides_set_results_search_text
Full name: azure-devops.azure_devops_search_code_search_results_fetch_code_search_results

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The Code Search Request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

provides_status_repository Read

Provides status of Repository. Official Azure DevOps REST API 7.2 endpoint: GET https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/status/repositories/{repository} (spec: search/7.2/search.json).

Lua path: app.integrations.azure_devops.provides_status_repository
Full name: azure-devops.azure_devops_search_repositories_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`repository`	string	yes	Repository ID or repository name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

provides_status_tfvc_repository Read

Provides status of TFVC Repository. Official Azure DevOps REST API 7.2 endpoint: GET https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/status/tfvc (spec: search/7.2/search.json).

Lua path: app.integrations.azure_devops.provides_status_tfvc_repository
Full name: azure-devops.azure_devops_search_tfvc_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

provides_set_results_search_request Read

Provides a set of results for the search request. Official Azure DevOps REST API 7.2 endpoint: POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/wikisearchresults (spec: search/7.2/search.json).

Lua path: app.integrations.azure_devops.provides_set_results_search_request
Full name: azure-devops.azure_devops_search_wiki_search_results_fetch_wiki_search_results

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The Wiki Search Request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

provides_set_results_search_text Read

Lua path: app.integrations.azure_devops.provides_set_results_search_text
Full name: azure-devops.azure_devops_search_work_item_search_results_fetch_work_item_search_results

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The Work Item Search Request.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_or_update_aces_acl_provided_token_request_body_contains_target_token_list_aces_https_docs_microsoft_com_en_rest_api_security_access_control_entries_set_access_control_entries_accesscontrolentry_and_optional_merge_parameter_case_collision_by_identity_descriptor_with_existing_ace_acl_merge_parameter_determines_behavior_if_set_existing_ace_has_its_allow_and_deny_merged_with_incoming_ace_allow_and_deny_if_unset_existing_ace_is_displaced_optimal_performance_and_reliability_it_is_strongly_recommended_batch_multiple_aces_single_request_rather_than_sending_individual_requests_batching_requests_improves_efficiency_reduces_overhead_and_helps_ensure_successful_completion_your_operations

Read

Add or update ACEs in the ACL for the provided token. The request body contains the target token, a list of [ACEs](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access-control-entries/set-access-control-entries?#accesscontrolentry) and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced. For optimal performance and reliability, it is strongly recommended to batch multiple ACEs in a single request rather than sending individual requests. Batching requests improves efficiency, reduces overhead, and helps ensure successful completion of your operations. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/accesscontrolentries/{securityNamespaceId} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.add_or_update_aces_acl_provided_token_request_body_contains_target_token_list_aces_https_docs_microsoft_com_en_rest_api_security_access_control_entries_set_access_control_entries_accesscontrolentry_and_optional_merge_parameter_case_collision_by_identity_descriptor_with_existing_ace_acl_merge_parameter_determines_behavior_if_set_existing_ace_has_its_allow_and_deny_merged_with_incoming_ace_allow_and_deny_if_unset_existing_ace_is_displaced_optimal_performance_and_reliability_it_is_strongly_recommended_batch_multiple_aces_single_request_rather_than_sending_individual_requests_batching_requests_improves_efficiency_reduces_overhead_and_helps_ensure_successful_completion_your_operations
Full name: azure-devops.azure_devops_security_access_control_entries_set_access_control_entries

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`security_namespace_id`	string	yes	Security namespace identifier.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

remove_specified_aces_from_acl_belonging_specified_token Write

Remove the specified ACEs from the ACL belonging to the specified token. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/accesscontrolentries/{securityNamespaceId} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.remove_specified_aces_from_acl_belonging_specified_token
Full name: azure-devops.azure_devops_security_access_control_entries_remove_access_control_entries

Parameter	Type	Required	Description
`security_namespace_id`	string	yes	Security namespace identifier.
`organization`	string	yes	The name of the Azure DevOps organization.
`token`	string	no	The token whose ACL should be modified.
`descriptors`	string	no	String containing a list of identity descriptors separated by ',' whose entries should be removed.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

return_list_access_control_lists_specified_security_namespace_and_token_all_acls_security_namespace_will_be_retrieved_if_no_optional_parameters_are_provided_note_that_response_will_include_all_project_ids_including_projects_current_user_does_not_have_access

Read

Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided. Note that the response will include all project IDs, including projects the current user does not have access to. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/accesscontrollists/{securityNamespaceId} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.return_list_access_control_lists_specified_security_namespace_and_token_all_acls_security_namespace_will_be_retrieved_if_no_optional_parameters_are_provided_note_that_response_will_include_all_project_ids_including_projects_current_user_does_not_have_access
Full name: azure-devops.azure_devops_security_access_control_lists_query

Parameter	Type	Required	Description
`security_namespace_id`	string	yes	Security namespace identifier.
`organization`	string	yes	The name of the Azure DevOps organization.
`token`	string	no	Security token
`descriptors`	string	no	An optional filter string containing a list of identity descriptors separated by ',' whose ACEs should be retrieved. If this is left null, entire ACLs will be returned.
`include_extended_info`	boolean	no	If true, populate the extended information properties for the access control entries contained in the returned lists.
`recurse`	boolean	no	If true and this is a hierarchical namespace, return child ACLs of the specified token.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_or_update_one_or_more_access_control_lists_all_data_that_currently_exists_acls_supplied_will_be_overwritten Read

Create or update one or more access control lists. All data that currently exists for the ACLs supplied will be overwritten. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/accesscontrollists/{securityNamespaceId} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.create_or_update_one_or_more_access_control_lists_all_data_that_currently_exists_acls_supplied_will_be_overwritten
Full name: azure-devops.azure_devops_security_access_control_lists_set_access_control_lists

Parameter	Type	Required	Description
`body`	object	yes	A list of ACLs to create or update.
`security_namespace_id`	string	yes	Security namespace identifier.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

remove_access_control_lists_under_specfied_security_namespace Write

Remove access control lists under the specfied security namespace. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/accesscontrollists/{securityNamespaceId} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.remove_access_control_lists_under_specfied_security_namespace
Full name: azure-devops.azure_devops_security_access_control_lists_remove_access_control_lists

Parameter	Type	Required	Description
`security_namespace_id`	string	yes	Security namespace identifier.
`organization`	string	yes	The name of the Azure DevOps organization.
`tokens`	string	no	One or more comma-separated security tokens
`recurse`	boolean	no	If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

evaluates_whether_caller_has_specified_permissions_specified_set_security_tokens Read

Evaluates whether the caller has the specified permissions on the specified set of security tokens. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/permissions/{securityNamespaceId}/{permissions} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.evaluates_whether_caller_has_specified_permissions_specified_set_security_tokens
Full name: azure-devops.azure_devops_security_permissions_has_permissions

Parameter	Type	Required	Description
`security_namespace_id`	string	yes	Security namespace identifier.
`organization`	string	yes	The name of the Azure DevOps organization.
`permissions`	number	yes	Permissions to evaluate.
`tokens`	string	no	One or more security tokens to evaluate.
`always_allow_administrators`	boolean	no	If true and if the caller is an administrator, always return true.
`delimiter`	string	no	Optional security token separator. Defaults to ",".
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

removes_specified_permissions_security_token_user_or_group Write

Removes the specified permissions on a security token for a user or group. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/permissions/{securityNamespaceId}/{permissions} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.removes_specified_permissions_security_token_user_or_group
Full name: azure-devops.azure_devops_security_permissions_remove_permission

Parameter	Type	Required	Description
`security_namespace_id`	string	yes	Security namespace identifier.
`descriptor`	string	no	Identity descriptor of the user to remove permissions for.
`organization`	string	yes	The name of the Azure DevOps organization.
`permissions`	number	yes	Permissions to remove.
`token`	string	no	Security token to remove permissions for.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

evaluates_multiple_permissions_calling_user_note_this_method_does_not_aggregate_results_nor_does_it_short_circuit_if_one_permissions_evaluates_false

Read

Evaluates multiple permissions for the calling user. Note: This method does not aggregate the results, nor does it short-circuit if one of the permissions evaluates to false. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/security/permissionevaluationbatch (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.evaluates_multiple_permissions_calling_user_note_this_method_does_not_aggregate_results_nor_does_it_short_circuit_if_one_permissions_evaluates_false
Full name: azure-devops.azure_devops_security_permissions_has_permissions_batch

Parameter	Type	Required	Description
`body`	object	yes	The set of evaluation requests.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

list_all_security_namespaces_or_just_specified_namespace Read

List all security namespaces or just the specified namespace. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/securitynamespaces/{securityNamespaceId} (spec: security/7.2/security.json).

Lua path: app.integrations.azure_devops.list_all_security_namespaces_or_just_specified_namespace
Full name: azure-devops.azure_devops_security_security_namespaces_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`security_namespace_id`	string	yes	Security namespace identifier.
`local_only`	boolean	no	If true, retrieve only local security namespaces.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_role_assignments_resource Read

Get role assignments for the resource Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId} (spec: securityRoles/7.2/securityRoles.json).

Lua path: app.integrations.azure_devops.get_role_assignments_resource
Full name: azure-devops.azure_devops_security_roles_roleassignments_list

Parameter	Type	Required	Description
`scope_id`	string	yes	Id of the assigned scope
`resource_id`	string	yes	Id of the resource that is assigned the scope
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_role_assignments_resource Read

Set role assignments on a resource Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId} (spec: securityRoles/7.2/securityRoles.json).

Lua path: app.integrations.azure_devops.set_role_assignments_resource
Full name: azure-devops.azure_devops_security_roles_roleassignments_set_role_assignments

Parameter	Type	Required	Description
`body`	object	yes	Roles to be assigned
`scope_id`	string	yes	Id of the assigned scope
`resource_id`	string	yes	Id of the resource on which the role is to be assigned
`organization`	string	yes	The name of the Azure DevOps organization.
`limit_to_caller_identity_domain`	boolean	no	query parameter `limitToCallerIdentityDomain`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_apis_securityroles_scopes_scopeid_roleassignments_resources_resourceid Write

PATCH /{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId} Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId} (spec: securityRoles/7.2/securityRoles.json).

Lua path: app.integrations.azure_devops.patch_organization_apis_securityroles_scopes_scopeid_roleassignments_resources_resourceid
Full name: azure-devops.azure_devops_security_roles_roleassignments_remove_role_assignments

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`scope_id`	string	yes	path parameter `scopeId`.
`resource_id`	string	yes	path parameter `resourceId`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_role_assignment_resource Read

Set role assignment on a resource Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}/{identityId} (spec: securityRoles/7.2/securityRoles.json).

Lua path: app.integrations.azure_devops.set_role_assignment_resource
Full name: azure-devops.azure_devops_security_roles_roleassignments_set_role_assignment

Parameter	Type	Required	Description
`body`	object	yes	Roles to be assigned
`scope_id`	string	yes	Id of the assigned scope
`resource_id`	string	yes	Id of the resource on which the role is to be assigned
`identity_id`	string	yes	path parameter `identityId`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

remove_role_assignment_resource Write

Remove the role assignment on a resource Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}/{identityId} (spec: securityRoles/7.2/securityRoles.json).

Lua path: app.integrations.azure_devops.remove_role_assignment_resource
Full name: azure-devops.azure_devops_security_roles_roleassignments_remove_role_assignment

Parameter	Type	Required	Description
`scope_id`	string	yes	Id of the assigned scope
`resource_id`	string	yes	Id of the resource on which the role is to be removed
`identity_id`	string	yes	Identity on which the assignment is to be removed
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_apis_securityroles_scopes_scopeid_roledefinitions Read

GET /{organization}/_apis/securityroles/scopes/{scopeId}/roledefinitions Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roledefinitions (spec: securityRoles/7.2/securityRoles.json).

Lua path: app.integrations.azure_devops.get_organization_apis_securityroles_scopes_scopeid_roledefinitions
Full name: azure-devops.azure_devops_security_roles_roledefinitions_list

Parameter	Type	Required	Description
`scope_id`	string	yes	path parameter `scopeId`.
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_new_service_endpoint Read

Creates a new service endpoint Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.creates_new_service_endpoint
Full name: azure-devops.azure_devops_service_endpoint_endpoints_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Service endpoint to create
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

update_service_endpoints Write

Update the service endpoints. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.update_service_endpoints
Full name: azure-devops.azure_devops_service_endpoint_endpoints_update_service_endpoints

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Names of the service endpoints to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

update_service_endpoint Write

Update the service endpoint Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId} (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.update_service_endpoint
Full name: azure-devops.azure_devops_service_endpoint_endpoints_update_service_endpoint

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated data for the endpoint
`endpoint_id`	string	yes	Endpoint Id of the endpoint to update
`operation`	string	no	operation type
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

share_service_endpoint_across_projects Read

Share service endpoint across projects Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId} (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.share_service_endpoint_across_projects
Full name: azure-devops.azure_devops_service_endpoint_endpoints_share_service_endpoint

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Project reference details of the target project
`endpoint_id`	string	yes	Endpoint Id of the endpoint to share
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

delete_service_endpoint Read

Delete a service endpoint Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId} (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.delete_service_endpoint
Full name: azure-devops.azure_devops_service_endpoint_endpoints_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`endpoint_id`	string	yes	Endpoint Id of endpoint to delete
`project_ids`	string	no	project Ids from which endpoint needs to be deleted
`deep`	boolean	no	delete the spn created by endpoint
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_service_endpoint_types Read

Get service endpoint types. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/serviceendpoint/types (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.get_service_endpoint_types
Full name: azure-devops.azure_devops_service_endpoint_types_get_service_endpoint_types

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`type`	string	no	Type of service endpoint.
`scheme`	string	no	Scheme of service endpoint.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_service_endpoint_types_with_passed_types_filter Read

Get service endpoint types with passed types filter. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/serviceendpoint/types (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.get_service_endpoint_types_with_passed_types_filter
Full name: azure-devops.azure_devops_service_endpoint_types_get_filtered_service_endpoint_types

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Filter to limit returned types
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

use_executeserviceendpointrequest_api_instead Read

Use ExecuteServiceEndpointRequest API Instead Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpointproxy (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.use_executeserviceendpointrequest_api_instead
Full name: azure-devops.azure_devops_service_endpoint_endpointproxy_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Describes the data source to fetch.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_service_endpoints_by_name Read

Get the service endpoints by name. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.get_service_endpoints_by_name
Full name: azure-devops.azure_devops_service_endpoint_endpoints_get_service_endpoints_by_names

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`endpoint_names`	string	no	Names of the service endpoints.
`type`	string	no	Type of the service endpoints.
`auth_schemes`	string	no	Authorization schemes used for service endpoints.
`owner`	string	no	Owner for service endpoints.
`include_failed`	boolean	no	Failed flag for service endpoints.
`include_details`	boolean	no	Flag to include more details for service endpoints. This is for internal use only and the flag will be treated as false for all other requests
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

gets_service_endpoints_and_patch_new_authorization_parameters Read

Gets the service endpoints and patch new authorization parameters Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.gets_service_endpoints_and_patch_new_authorization_parameters
Full name: azure-devops.azure_devops_service_endpoint_endpoints_get_service_endpoints_with_refreshed_authentication

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Scope, Validity of Token requested.
`project`	string	yes	Project ID or project name
`endpoint_ids`	string	no	Ids of the service endpoints.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_service_endpoint_details Read

Get the service endpoint details. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints/{endpointId} (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.get_service_endpoint_details
Full name: azure-devops.azure_devops_service_endpoint_endpoints_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`endpoint_id`	string	yes	Id of the service endpoint.
`action_filter`	string	no	Action filter for the service connection. It specifies the action which can be performed on the service connection.
`load_confidential_data`	boolean	no	Flag to include confidential details of service endpoint. This is for internal use only.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_service_endpoint_execution_records Read

Get service endpoint execution records. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/{endpointId}/executionhistory (spec: serviceEndpoint/7.2/serviceEndpoint.json).

Lua path: app.integrations.azure_devops.get_service_endpoint_execution_records
Full name: azure-devops.azure_devops_service_endpoint_executionhistory_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`endpoint_id`	string	yes	Id of the service endpoint.
`top`	number	no	Number of service endpoint execution records to get.
`continuation_token`	number	no	A continuation token, returned by a previous call to this method, that can be used to return the next set of records
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

queries_status_information_service_all_up_or_scoped_particular_service_and_or_geography Read

Queries status information for the service all-up, or scoped to a particular service and/or geography Official Azure DevOps REST API 7.2 endpoint: GET https://status.dev.azure.com/_apis/status/health (spec: status/7.2/status.json).

Lua path: app.integrations.azure_devops.queries_status_information_service_all_up_or_scoped_particular_service_and_or_geography
Full name: azure-devops.azure_devops_status_health_get

Parameter	Type	Required	Description
`services`	string	no	A comma-separated list of services for which to get status information for. Supported values: Artifacts, Boards, Core services, Other services, Pipelines, Repos, Test Plans.
`geographies`	string	no	A comma-separated list of geographies for which to get status information for. Supported values: APAC, AU, BR, CA, EU, IN, UK, US.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

check_availability_symbol_service_this_includes_checking_feature_flag_and_possibly_license_future_note_this_is_not_anonymous_endpoint_and_caller_will_be_redirected_authentication_before_hitting_it

Read

Check the availability of symbol service. This includes checking for feature flag, and possibly license in future. Note this is NOT an anonymous endpoint, and the caller will be redirected to authentication before hitting it. Official Azure DevOps REST API 7.2 endpoint: GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/availability (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.check_availability_symbol_service_this_includes_checking_feature_flag_and_possibly_license_future_note_this_is_not_anonymous_endpoint_and_caller_will_be_redirected_authentication_before_hitting_it
Full name: azure-devops.azure_devops_symbol_availability_check_availability

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_client_package Read

Get the client package. Official Azure DevOps REST API 7.2 endpoint: GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/client/{clientType} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.get_client_package
Full name: azure-devops.azure_devops_symbol_client_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`client_type`	string	yes	Either "EXE" for a zip file containing a Windows symbol client (a.k.a. symbol.exe) along with dependencies, or "TASK" for a VSTS task that can be run on a VSTS build agent. All the other values are invalid. The parameter is case-insensitive.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_symbol_request_by_request_name Read

Get a symbol request by request name. Official Azure DevOps REST API 7.2 endpoint: GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.get_symbol_request_by_request_name
Full name: azure-devops.azure_devops_symbol_requests_get_requests_request_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`request_name`	string	no	The symbol request name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_new_symbol_request Write

Create a new symbol request. Official Azure DevOps REST API 7.2 endpoint: POST https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.create_new_symbol_request
Full name: azure-devops.azure_devops_symbol_requests_create_requests

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The symbol request to create.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_symbol_request_by_request_name Write

Update a symbol request by request name. Official Azure DevOps REST API 7.2 endpoint: PATCH https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.update_symbol_request_by_request_name
Full name: azure-devops.azure_devops_symbol_requests_update_requests_request_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The symbol request.
`request_name`	string	no	The symbol request name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_symbol_request_by_request_name Write

Delete a symbol request by request name. Official Azure DevOps REST API 7.2 endpoint: DELETE https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.delete_symbol_request_by_request_name
Full name: azure-devops.azure_devops_symbol_requests_delete_requests_request_name

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`request_name`	string	no	The symbol request name.
`synchronous`	boolean	no	If true, delete all the debug entries under this request synchronously in the current session. If false, the deletion will be postponed to a later point and be executed automatically by the system.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_symbol_request_by_request_identifier Read

Get a symbol request by request identifier. Official Azure DevOps REST API 7.2 endpoint: GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests/{requestId} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.get_symbol_request_by_request_identifier
Full name: azure-devops.azure_devops_symbol_requests_get_requests_request_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`request_id`	string	yes	The symbol request identifier.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_debug_entries_symbol_request_specified_by_its_identifier Write

Create debug entries for a symbol request as specified by its identifier. Official Azure DevOps REST API 7.2 endpoint: POST https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests/{requestId} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.create_debug_entries_symbol_request_specified_by_its_identifier
Full name: azure-devops.azure_devops_symbol_requests_create_requests_request_id_debug_entries

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A batch that contains debug entries to create.
`request_id`	string	yes	The symbol request identifier.
`collection`	string	no	A valid debug entry collection name. Must be "debugentries".
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_symbol_request_by_request_identifier Write

Update a symbol request by request identifier. Official Azure DevOps REST API 7.2 endpoint: PATCH https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests/{requestId} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.update_symbol_request_by_request_identifier
Full name: azure-devops.azure_devops_symbol_requests_update_requests_request_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The symbol request.
`request_id`	string	yes	The symbol request identifier.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_symbol_request_by_request_identifier Write

Delete a symbol request by request identifier. Official Azure DevOps REST API 7.2 endpoint: DELETE https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests/{requestId} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.delete_symbol_request_by_request_identifier
Full name: azure-devops.azure_devops_symbol_requests_delete_requests_request_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`request_id`	string	yes	The symbol request identifier.
`synchronous`	boolean	no	If true, delete all the debug entries under this request synchronously in the current session. If false, the deletion will be postponed to a later point and be executed automatically by the system.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_stitched_debug_entry_symbol_request_specified_by_symbol_request_identifier_and_debug_entry_identifier Read

Get a stitched debug entry for a symbol request as specified by symbol request identifier and debug entry identifier. Official Azure DevOps REST API 7.2 endpoint: GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/requests/{requestId}/contents/{debugEntryId} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.get_stitched_debug_entry_symbol_request_specified_by_symbol_request_identifier_and_debug_entry_identifier
Full name: azure-devops.azure_devops_symbol_contents_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`request_id`	string	yes	The symbol request identifier.
`debug_entry_id`	string	yes	The debug entry identifier.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

given_client_key_returns_best_matched_debug_entry Read

Given a client key, returns the best matched debug entry. Official Azure DevOps REST API 7.2 endpoint: GET https://artifacts.dev.azure.com/{organization}/_apis/symbol/symsrv/{debugEntryClientKey} (spec: symbol/7.2/symbol.json).

Lua path: app.integrations.azure_devops.given_client_key_returns_best_matched_debug_entry
Full name: azure-devops.azure_devops_symbol_symsrv_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`debug_entry_client_key`	string	yes	A "client key" used by both ends of Microsoft's symbol protocol to identify a debug entry. The semantics of client key is governed by symsrv and is beyond the scope of this documentation.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_points Write

Get a list of test points. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_list_test_points
Full name: azure-devops.azure_devops_test_points_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan.
`suite_id`	number	yes	ID of the suite that contains the points.
`wit_fields`	string	no	Comma-separated list of work item field names.
`configuration_id`	string	no	Get test points for specific configuration.
`test_case_id`	string	no	Get test points for a specific test case, valid when configurationId is not set.
`test_point_ids`	string	no	Get test points for comma-separated list of test point IDs, valid only when configurationId and testCaseId are not set.
`include_point_details`	boolean	no	Include all properties for the test point.
`skip`	number	no	Number of test points to skip..
`top`	number	no	Number of test points to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_test_point Write

Get a test point. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points/{pointIds} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_point
Full name: azure-devops.azure_devops_test_points_get_point

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan.
`suite_id`	number	yes	ID of the suite that contains the point.
`point_ids`	number	yes	ID of the test point to get.
`wit_fields`	string	no	Comma-separated list of work item field names.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_test_points Write

Update test points. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points/{pointIds} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.update_test_points
Full name: azure-devops.azure_devops_test_points_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Data to update.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan.
`suite_id`	number	yes	ID of the suite that contains the points.
`point_ids`	string	yes	ID of the test point to get. Use a comma-separated list of IDs to update multiple test points.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_all_test_cases_suite Write

Get all test cases in a suite. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}/testcases (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_all_test_cases_suite
Full name: azure-devops.azure_devops_test_test_suites_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suites.
`suite_id`	number	yes	ID of the suite to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_specific_test_case_test_suite_with_test_case_id Write

Get a specific test case in a test suite with test case id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}/testcases/{testCaseIds} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_specific_test_case_test_suite_with_test_case_id
Full name: azure-devops.azure_devops_test_test_suites_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suites.
`suite_id`	number	yes	ID of the suite that contains the test case.
`test_case_ids`	number	yes	ID of the test case to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

add_test_cases_suite Write

Add test cases to suite. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}/testcases/{testCaseIds} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.add_test_cases_suite
Full name: azure-devops.azure_devops_test_test_suites_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suite.
`suite_id`	number	yes	ID of the test suite to which the test cases must be added.
`test_case_ids`	string	yes	IDs of the test cases to add to the suite. Ids are specified in comma separated format.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

updates_properties_test_case_association_suite Write

Updates the properties of the test case association in a suite. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}/testcases/{testCaseIds} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.updates_properties_test_case_association_suite
Full name: azure-devops.azure_devops_test_test_suites_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Model for updation of the properties of test case suite association.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suite.
`suite_id`	number	yes	ID of the test suite to which the test cases must be added.
`test_case_ids`	string	yes	IDs of the test cases to add to the suite. Ids are specified in comma separated format.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

test_points_associated_with_test_cases_are_removed_from_test_suite_test_case_work_item_is_not_deleted_from_system_see_test_cases_resource_delete_test_case_permanently

Write

The test points associated with the test cases are removed from the test suite. The test case work item is not deleted from the system. See test cases resource to delete a test case permanently. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}/testcases/{testCaseIds} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.test_points_associated_with_test_cases_are_removed_from_test_suite_test_case_work_item_is_not_deleted_from_system_see_test_cases_resource_delete_test_case_permanently
Full name: azure-devops.azure_devops_test_test_suites_remove_test_cases_from_suite_url

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suite.
`suite_id`	number	yes	ID of the suite to get.
`test_case_ids`	string	yes	IDs of the test cases to remove from the suite.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_history_test_method_using_testhistoryquery Write

Get history of a test method using TestHistoryQuery Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/Results/testhistory (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_history_test_method_using_testhistoryquery
Full name: azure-devops.azure_devops_test_test_history_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestHistoryQuery to get history
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_test_result_attachments_reference Write

Get list of test result attachments reference. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/attachments (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_list_test_result_attachments_reference
Full name: azure-devops.azure_devops_test_attachments_get_test_result_attachments

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run that contains the result.
`test_case_result_id`	number	yes	ID of the test result.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

attach_file_test_result Write

Attach a file to a test result. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/attachments (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.attach_file_test_result
Full name: azure-devops.azure_devops_test_attachments_create_test_result_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Attachment details TestAttachmentRequestModel
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run that contains the result.
`test_case_result_id`	number	yes	ID of the test result against which attachment has to be uploaded.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

download_test_result_attachment_by_its_id Write

Download a test result attachment by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/attachments/{attachmentId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.download_test_result_attachment_by_its_id
Full name: azure-devops.azure_devops_test_attachments_get_test_result_attachment_zip

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run that contains the testCaseResultId.
`test_case_result_id`	number	yes	ID of the test result whose attachment has to be downloaded.
`attachment_id`	number	yes	ID of the test result attachment to be downloaded.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_iterations_result Write

Get iterations for a result Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/iterations (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_iterations_result
Full name: azure-devops.azure_devops_test_iterations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run that contains the result.
`test_case_result_id`	number	yes	ID of the test result that contains the iterations.
`include_action_results`	boolean	no	Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_iteration_result Write

Get iteration for a result Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/Results/{testCaseResultId}/iterations/{iterationId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_iteration_result
Full name: azure-devops.azure_devops_test_iterations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run that contains the result.
`test_case_result_id`	number	yes	ID of the test result that contains the iterations.
`iteration_id`	number	yes	Id of the test results Iteration.
`include_action_results`	boolean	no	Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_list_test_run_attachments_reference Write

Get list of test run attachments reference. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/attachments (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_list_test_run_attachments_reference
Full name: azure-devops.azure_devops_test_attachments_get_test_run_attachments

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

attach_file_test_run Write

Attach a file to a test run. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/attachments (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.attach_file_test_run
Full name: azure-devops.azure_devops_test_attachments_create_test_run_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Attachment details TestAttachmentRequestModel
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run against which attachment has to be uploaded.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

download_test_run_attachment_by_its_id Write

Download a test run attachment by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/attachments/{attachmentId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.download_test_run_attachment_by_its_id
Full name: azure-devops.azure_devops_test_attachments_get_test_run_attachment_zip

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run whose attachment has to be downloaded.
`attachment_id`	number	yes	ID of the test run attachment to be downloaded.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_code_coverage_data_test_run Write

Get code coverage data for a test run Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/codecoverage (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_code_coverage_data_test_run
Full name: azure-devops.azure_devops_test_code_coverage_get_test_run_code_coverage

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the test run for which code coverage data needs to be fetched.
`flags`	number	no	Value of flags determine the level of code coverage details to be fetched. Flags are additive. Expected Values are 1 for Modules, 2 for Functions, 4 for BlockData.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_results_test_run Write

Get test results for a test run. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/results (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_results_test_run
Full name: azure-devops.azure_devops_test_results_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test run ID of test results to fetch.
`details_to_include`	string	no	Details to include with test results. Default is None. Other values are Iterations and WorkItems.
`skip`	number	no	Number of test results to skip from beginning.
`top`	number	no	Number of test results to return. Maximum is 1000 when detailsToInclude is None and 200 otherwise.
`outcomes`	string	no	Comma separated list of test outcomes to filter test results.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.6`.

add_test_results_test_run Write

Add test results to a test run. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/results (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.add_test_results_test_run
Full name: azure-devops.azure_devops_test_results_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of test results to add.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test run ID into which test results to add.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.6`.

update_test_results_test_run Write

Update test results in a test run. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/results (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.update_test_results_test_run
Full name: azure-devops.azure_devops_test_results_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of test results to update.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test run ID whose test results to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.6`.

get_test_result_test_run Write

Get a test result for a test run. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/Runs/{runId}/results/{testCaseResultId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_result_test_run
Full name: azure-devops.azure_devops_test_results_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test run ID of a test result to fetch.
`test_case_result_id`	number	yes	Test result ID.
`details_to_include`	string	no	Details to include with test results. Default is None. Other values are Iterations, WorkItems and SubResults.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.6`.

get_code_coverage_data_build Write

Get code coverage data for a build. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/codecoverage (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_code_coverage_data_build
Full name: azure-devops.azure_devops_test_code_coverage_get_build_code_coverage

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	ID of the build for which code coverage data needs to be fetched.
`flags`	number	no	Value of flags determine the level of code coverage details to be fetched. Flags are additive. Expected Values are 1 for Modules, 2 for Functions, 4 for BlockData.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_points_using_query Write

Get test points using query. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/points (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_points_using_query
Full name: azure-devops.azure_devops_test_points_get_points_by_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestPointsQuery to get test points.
`project`	string	yes	Project ID or project name
`skip`	number	no	Number of test points to skip..
`top`	number	no	Number of test points to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_test_result_retention_settings Write

Get test result retention settings Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/resultretentionsettings (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_result_retention_settings
Full name: azure-devops.azure_devops_test_result_retention_settings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_test_result_retention_settings Write

Update test result retention settings Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/test/resultretentionsettings (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.update_test_result_retention_settings
Full name: azure-devops.azure_devops_test_result_retention_settings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Test result retention settings details to be updated
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_runs Write

Get a list of test runs. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/runs (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_list_test_runs
Full name: azure-devops.azure_devops_test_runs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_uri`	string	no	URI of the build that the runs used.
`owner`	string	no	Team foundation ID of the owner of the runs.
`tmi_run_id`	string	no	query parameter `tmiRunId`.
`plan_id`	number	no	ID of the test plan that the runs are a part of.
`include_run_details`	boolean	no	If true, include all the properties of the runs.
`automated`	boolean	no	If true, only returns automated runs.
`skip`	number	no	Number of test runs to skip.
`top`	number	no	Number of test runs to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

create_new_test_run Write

Create new test run. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/test/runs (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.create_new_test_run
Full name: azure-devops.azure_devops_test_runs_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Run details RunCreateModel
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_test_run_by_its_id Write

Get a test run by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_run_by_its_id
Full name: azure-devops.azure_devops_test_runs_get_test_run_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to get.
`include_details`	boolean	no	Default value is true. It includes details like run statistics, release, build, test environment, post process state, and more.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_test_run_by_its_id Write

Update test run by its ID. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.update_test_run_by_its_id
Full name: azure-devops.azure_devops_test_runs_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Run details RunUpdateModel
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

delete_test_run_by_its_id Write

Delete a test run by its ID. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.delete_test_run_by_its_id
Full name: azure-devops.azure_devops_test_runs_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_test_run_statistics_used_when_we_want_get_summary_run_by_outcome Write

Get test run statistics , used when we want to get summary of a run by outcome. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId}/Statistics (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_test_run_statistics_used_when_we_want_get_summary_run_by_outcome
Full name: azure-devops.azure_devops_test_runs_get_test_run_statistics

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

delete_test_case Write

Delete a test case. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/test/testcases/{testCaseId} (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.delete_test_case
Full name: azure-devops.azure_devops_test_test_cases_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_case_id`	number	yes	Id of test case to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_sessions Write

Get a list of test sessions Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/test/session (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.get_list_test_sessions
Full name: azure-devops.azure_devops_test_session_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`period`	number	no	Period in days from now, for which test sessions are fetched.
`all_sessions`	boolean	no	If false, returns test sessions for current user. Otherwise, it returns test sessions for all users
`include_all_properties`	boolean	no	If true, it returns all properties of the test sessions. Otherwise, it returns the skinny version.
`source`	string	no	Source of the test session.
`include_only_completed_sessions`	boolean	no	If true, it returns test sessions in completed state. Otherwise, it returns test sessions for all states
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_test_session Write

Create a test session Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/{team}/_apis/test/session (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.create_test_session
Full name: azure-devops.azure_devops_test_session_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Test session details for creation
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_test_session Write

Update a test session Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/test/session (spec: test/7.2/test.json).

Lua path: app.integrations.azure_devops.update_test_session
Full name: azure-devops.azure_devops_test_session_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Test session details for update
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

find_list_all_test_suites_which_given_test_case_is_present_this_is_helpful_if_you_need_find_out_which_test_suites_are_using_test_case_when_you_need_make_changes_test_case

Write

Find the list of all test suites in which a given test case is present. This is helpful if you need to find out which test suites are using a test case, when you need to make changes to a test case. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/testplan/suites (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.find_list_all_test_suites_which_given_test_case_is_present_this_is_helpful_if_you_need_find_out_which_test_suites_are_using_test_case_when_you_need_make_changes_test_case
Full name: azure-devops.azure_devops_test_plan_test_suites_get_suites_by_test_case_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`test_case_id`	number	no	ID of the test case for which suites need to be fetched.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

clone_test_plan Write

Clone test plan Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/CloneOperation (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.clone_test_plan
Full name: azure-devops.azure_devops_test_plan_test_plan_clone_clone_test_plan

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Plan Clone Request Body detail TestPlanCloneRequest
`project`	string	yes	Project ID or project name
`deep_clone`	boolean	no	Clones all the associated test cases as well
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_clone_information Write

Get clone information. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/CloneOperation/{cloneOperationId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_clone_information
Full name: azure-devops.azure_devops_test_plan_test_plan_clone_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`clone_operation_id`	number	yes	Operation ID returned when we queue a clone operation
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_test_case_list_return_those_test_cases_which_have_all_configuration_ids_mentioned_optional_parameter_if_configuration_ids_is_null_it_return_all_test_cases

Write

Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional parameter. If configuration Ids is null, it return all the test cases Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_test_case_list_return_those_test_cases_which_have_all_configuration_ids_mentioned_optional_parameter_if_configuration_ids_is_null_it_return_all_test_cases
Full name: azure-devops.azure_devops_test_plan_suite_test_case_get_test_case_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan for which test cases are requested.
`suite_id`	number	yes	ID of the test suite for which test cases are requested.
`test_ids`	string	no	Test Case Ids to be fetched.
`configuration_ids`	string	no	Fetch Test Cases which contains all the configuration Ids specified.
`wit_fields`	string	no	Get the list of witFields.
`continuation_token`	string	no	If the list of test cases returned is not complete, a continuation token to query next batch of test cases is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test cases.
`return_identity_ref`	boolean	no	If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
`expand`	boolean	no	If set to false, will get a smaller payload containing only basic details about the suite test case object
`exclude_flags`	string	no	Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).
`is_recursive`	boolean	no	query parameter `isRecursive`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

add_test_cases_suite_with_specified_configurations Write

Add test cases to a suite with specified configurations Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.add_test_cases_suite_with_specified_configurations
Full name: azure-devops.azure_devops_test_plan_suite_test_case_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	SuiteTestCaseCreateUpdateParameters object.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan to which test cases are to be added.
`suite_id`	number	yes	ID of the test suite to which test cases are to be added.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_configurations_test_cases Write

Update the configurations for test cases Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.update_configurations_test_cases
Full name: azure-devops.azure_devops_test_plan_suite_test_case_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A SuiteTestCaseCreateUpdateParameters object.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan to which test cases are to be updated.
`suite_id`	number	yes	ID of the test suite to which test cases are to be updated.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

removes_test_cases_from_suite_based_list_test_case_ids_provided_this_api_can_be_used_remove_larger_number_test_cases Write

Removes test cases from a suite based on the list of test case Ids provided. This API can be used to remove a larger number of test cases. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.removes_test_cases_from_suite_based_list_test_case_ids_provided_this_api_can_be_used_remove_larger_number_test_cases
Full name: azure-devops.azure_devops_test_plan_suite_test_case_remove_test_cases_list_from_suite

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan from which test cases are to be removed.
`suite_id`	number	yes	ID of the test suite from which test cases are to be removed.
`test_ids`	string	no	Comma separated string of Test Case Ids to be removed.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_particular_test_case_from_suite Write

Get a particular Test Case from a Suite. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_particular_test_case_from_suite
Full name: azure-devops.azure_devops_test_plan_suite_test_case_get_test_case

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan for which test cases are requested.
`suite_id`	number	yes	ID of the test suite for which test cases are requested.
`test_case_id`	string	yes	Test Case Id to be fetched.
`wit_fields`	string	no	Get the list of witFields.
`return_identity_ref`	boolean	no	If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_particular_test_point_from_suite Write

Get a particular Test Point from a suite. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_particular_test_point_from_suite
Full name: azure-devops.azure_devops_test_plan_test_point_get_points

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan for which test points are requested.
`suite_id`	number	yes	ID of the test suite for which test points are requested.
`point_id`	string	no	ID of test point to be fetched.
`return_identity_ref`	boolean	no	If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
`include_point_details`	boolean	no	If set to false, will get a smaller payload containing only basic details about the test point object
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_test_points_this_is_used_reset_test_point_active_update_outcome_test_point_or_update_tester_test_point Write

Update Test Points. This is used to Reset test point to active, update the outcome of a test point or update the tester of a test point Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.update_test_points_this_is_used_reset_test_point_active_update_outcome_test_point_or_update_tester_test_point
Full name: azure-devops.azure_devops_test_plan_test_point_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A TestPointUpdateParams Object.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan for which test points are requested.
`suite_id`	number	yes	ID of the test suite for which test points are requested.
`include_point_details`	boolean	no	If set to false, will get a smaller payload containing only basic details about the test point object
`return_identity_ref`	boolean	no	If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_test_suites_plan Write

Get test suites for plan. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_test_suites_plan
Full name: azure-devops.azure_devops_test_plan_test_suites_get_test_suites_for_plan

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan for which suites are requested.
`expand`	string	no	Include the children suites and testers details.
`continuation_token`	string	no	If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
`as_tree_view`	boolean	no	If the suites returned should be in a tree structure.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_test_suite Write

Create test suite. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.create_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suites_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Parameters for suite creation
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suites.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_suite_by_suite_id Write

Get test suite by suite id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites/{suiteId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_test_suite_by_suite_id
Full name: azure-devops.azure_devops_test_plan_test_suites_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suites.
`suite_id`	number	yes	ID of the suite to get.
`expand`	string	no	Include the children suites and testers details
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_test_suite Write

Update test suite. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites/{suiteId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.update_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suites_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Parameters for suite updation
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suites.
`suite_id`	number	yes	ID of the parent suite.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_test_suite Write

Delete test suite. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites/{suiteId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.delete_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suites_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan that contains the suite.
`suite_id`	number	yes	ID of the test suite to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

clone_test_suite Write

Clone test suite Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Suites/CloneOperation (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.clone_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suite_clone_clone_test_suite

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Suite Clone Request Body detail TestSuiteCloneRequest
`project`	string	yes	Project ID or project name
`deep_clone`	boolean	no	Clones all the associated test cases as well
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_clone_information Write

Get clone information. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Suites/CloneOperation/{cloneOperationId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_clone_information
Full name: azure-devops.azure_devops_test_plan_test_suite_clone_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`clone_operation_id`	number	yes	Operation ID returned when we queue a clone operation
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

post_organization_project_apis_testplan_testcases_clonetestcaseoperation Write

POST /{organization}/{project}/_apis/testplan/TestCases/CloneTestCaseOperation Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/TestCases/CloneTestCaseOperation (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testplan_testcases_clonetestcaseoperation
Full name: azure-devops.azure_devops_test_plan_test_case_clone_clone_test_case

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_clone_information Write

Get clone information. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/TestCases/CloneTestCaseOperation/{cloneOperationId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_clone_information
Full name: azure-devops.azure_devops_test_plan_test_case_clone_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`clone_operation_id`	number	yes	Operation ID returned when we queue a clone operation
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_test_configurations Write

Get a list of test configurations. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_list_test_configurations
Full name: azure-devops.azure_devops_test_plan_configurations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`continuation_token`	string	no	If the list of configurations returned is not complete, a continuation token to query next batch of configurations is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test configurations.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_test_configuration Write

Create a test configuration. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.create_test_configuration
Full name: azure-devops.azure_devops_test_plan_configurations_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestConfigurationCreateUpdateParameters
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_test_configuration_by_its_id Write

Update a test configuration by its ID. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.update_test_configuration_by_its_id
Full name: azure-devops.azure_devops_test_plan_configurations_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestConfigurationCreateUpdateParameters
`project`	string	yes	Project ID or project name
`test_configuartion_id`	number	no	ID of the test configuration to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_test_configuration_by_its_id Write

Delete a test configuration by its ID. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.delete_test_configuration_by_its_id
Full name: azure-devops.azure_devops_test_plan_configurations_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_configuartion_id`	number	no	ID of the test configuration to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_configuration Write

Get a test configuration Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations/{testConfigurationId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_test_configuration
Full name: azure-devops.azure_devops_test_plan_configurations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_configuration_id`	number	yes	ID of the test configuration to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_plans Write

Get a list of test plans Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/plans (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_list_test_plans
Full name: azure-devops.azure_devops_test_plan_test_plans_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`owner`	string	no	Filter for test plan by owner ID or name
`continuation_token`	string	no	If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.
`include_plan_details`	boolean	no	Get all properties of the test plan
`filter_active_plans`	boolean	no	Get just the active plans
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_test_plan Write

Create a test plan. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/plans (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.create_test_plan
Full name: azure-devops.azure_devops_test_plan_test_plans_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A testPlanCreateParams object.TestPlanCreateParams
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_plan_by_id Write

Get a test plan by Id. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/plans/{planId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_test_plan_by_id
Full name: azure-devops.azure_devops_test_plan_test_plans_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_test_plan Write

Update a test plan. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/plans/{planId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.update_test_plan
Full name: azure-devops.azure_devops_test_plan_test_plans_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	A testPlanUpdateParams object.TestPlanUpdateParams
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan to be updated.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_test_plan Write

Delete a test plan. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/testplan/plans/{planId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.delete_test_plan
Full name: azure-devops.azure_devops_test_plan_test_plans_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan to be deleted.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_deleted_test_suites_test_plan Write

Get Deleted Test Suites for a Test Plan. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/TestPlan/{planId}/testsuite (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_deleted_test_suites_test_plan
Full name: azure-devops.azure_devops_test_plan_test_suite_recycle_bin_operations_get_deleted_test_suites_for_plan

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	ID of the test plan for which suites are requested.
`expand`	string	no	Include the children suites and testers details.
`continuation_token`	string	no	If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
`as_tree_view`	boolean	no	If the suites returned should be in a tree structure.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_deleted_test_plans Write

Get a list of deleted test plans Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/testplan (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_list_deleted_test_plans
Full name: azure-devops.azure_devops_test_plan_test_plan_recycle_bin_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`continuation_token`	string	no	If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restores_deleted_test_plan Write

Restores the deleted test plan Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/testplan/{planId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.restores_deleted_test_plan
Full name: azure-devops.azure_devops_test_plan_test_plan_recycle_bin_restore_deleted_test_plan

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The model containing the restore information
`project`	string	yes	Project ID or project name
`plan_id`	number	yes	The ID of the test plan to restore
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_deleted_test_suites_within_project Write

Get Deleted Test Suites within a Project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/testsuite (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_deleted_test_suites_within_project
Full name: azure-devops.azure_devops_test_plan_test_suite_recycle_bin_operations_get_deleted_test_suites_for_project

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`expand`	string	no	Include the children suites and testers details.
`continuation_token`	string	no	If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
`as_tree_view`	boolean	no	If the suites returned should be in a tree structure.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

restores_deleted_test_suite Write

Restores the deleted test suite Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/testsuite/{suiteId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.restores_deleted_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suite_recycle_bin_operations_restore_deleted_test_suite

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The model containing the restore information
`project`	string	yes	Project ID or project name
`suite_id`	number	yes	The ID of the test suite to restore
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_suite_entries_test_suite Write

Get a list of test suite entries in the test suite. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_list_test_suite_entries_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suite_entry_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`suite_id`	number	yes	Id of the parent suite.
`suite_entry_type`	string	no	query parameter `suiteEntryType`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

reorder_test_suite_entries_test_suite Write

Reorder test suite entries in the test suite. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.reorder_test_suite_entries_test_suite
Full name: azure-devops.azure_devops_test_plan_test_suite_entry_reorder_suite_entries

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of SuiteEntry to reorder.
`project`	string	yes	Project ID or project name
`suite_id`	number	yes	Id of the parent test suite.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_test_case Write

Delete a test case. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/testplan/testcases/{testCaseId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.delete_test_case
Full name: azure-devops.azure_devops_test_plan_test_cases_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_case_id`	number	yes	Id of test case to be deleted.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_variables Write

Get a list of test variables. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/variables (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_list_test_variables
Full name: azure-devops.azure_devops_test_plan_variables_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`continuation_token`	string	no	If the list of variables returned is not complete, a continuation token to query next batch of variables is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test variables.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_test_variable Write

Create a test variable. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/testplan/variables (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.create_test_variable
Full name: azure-devops.azure_devops_test_plan_variables_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestVariableCreateUpdateParameters
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_variable_by_its_id Write

Get a test variable by its ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/testplan/variables/{testVariableId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.get_test_variable_by_its_id
Full name: azure-devops.azure_devops_test_plan_variables_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_variable_id`	number	yes	ID of the test variable to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_test_variable_by_its_id Write

Update a test variable by its ID. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/variables/{testVariableId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.update_test_variable_by_its_id
Full name: azure-devops.azure_devops_test_plan_variables_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestVariableCreateUpdateParameters
`project`	string	yes	Project ID or project name
`test_variable_id`	number	yes	ID of the test variable to update.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_test_variable_by_its_id Write

Delete a test variable by its ID. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/testplan/variables/{testVariableId} (spec: testPlan/7.2/testPlan.json).

Lua path: app.integrations.azure_devops.delete_test_variable_by_its_id
Full name: azure-devops.azure_devops_test_plan_variables_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_variable_id`	number	yes	ID of the test variable to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

http_tfsserver_8080_tfs_defaultcollection_apis_test_codecoverage_buildid_10_deltabuildid_9_request_build_id_and_delta_build_id_optional

Write

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: build id and delta build id (optional) Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/codecoverage (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.http_tfsserver_8080_tfs_defaultcollection_apis_test_codecoverage_buildid_10_deltabuildid_9_request_build_id_and_delta_build_id_optional
Full name: azure-devops.azure_devops_test_results_codecoverage_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`delta_build_id`	number	no	query parameter `deltaBuildId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

http_tfsserver_8080_tfs_defaultcollection_apis_test_codecoverage_buildid_10_request_json_code_coverage_summary Write

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/codecoverage (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.http_tfsserver_8080_tfs_defaultcollection_apis_test_codecoverage_buildid_10_request_json_code_coverage_summary
Full name: azure-devops.azure_devops_test_results_codecoverage_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_file_coverage_specified_file Write

Get file coverage for the specified file Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/codecoverage/filecoverage (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_file_coverage_specified_file
Full name: azure-devops.azure_devops_test_results_filecoverage_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	File details with pull request iteration context
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_codecoverage_sourceview Write

GET /{organization}/{project}/_apis/testresults/codecoverage/sourceview Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/codecoverage/sourceview (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_codecoverage_sourceview
Full name: azure-devops.azure_devops_test_results_codecoverage_fetch_source_code_coverage_report

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_coverage_status_last_successful_build_definition_optionally_scoped_specific_branch Write

Gets the coverage status for the last successful build of a definition, optionally scoped to a specific branch Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/codecoverage/status/{definition} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.gets_coverage_status_last_successful_build_definition_optionally_scoped_specific_branch
Full name: azure-devops.azure_devops_test_results_status_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`definition`	string	yes	The ID or name of the definition.
`branch_name`	string	no	The branch name.
`label`	string	no	The String to replace the default text on the left side of the badge.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_custom_test_fields_given_custom_test_field_scope Write

Returns List of custom test fields for the given custom test field scope. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/extensionfields (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_list_custom_test_fields_given_custom_test_field_scope
Full name: azure-devops.azure_devops_test_results_extensionfields_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`scope_filter`	string	no	Scope of custom test fields which are to be returned.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_custom_test_fields_based_data_provided Write

Creates custom test fields based on the data provided. Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/extensionfields (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.creates_custom_test_fields_based_data_provided
Full name: azure-devops.azure_devops_test_results_extensionfields_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	NewFields is an array of type CustomTestFieldDefinition.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_details_custom_test_field_which_is_updated Write

Returns details of the custom test field which is updated. Official Azure DevOps REST API 7.2 endpoint: PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/extensionfields (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_details_custom_test_field_which_is_updated
Full name: azure-devops.azure_devops_test_results_extensionfields_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Custom test field which has to be updated.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_details_custom_test_field_specified_testextensionfieldid Write

Returns details of the custom test field for the specified testExtensionFieldId. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/extensionfields/{testExtensionFieldId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_details_custom_test_field_specified_testextensionfieldid
Full name: azure-devops.azure_devops_test_results_extensionfields_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_extension_field_id`	number	yes	Custom test field id which has to be deleted.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_summary_test_results Write

Get summary of test results. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/metrics (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_summary_test_results
Full name: azure-devops.azure_devops_test_results_metrics_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	no	Pipeline Id. This is same as build Id.
`stage_name`	string	no	Name of the stage. Maximum supported length for name is 256 character.
`phase_name`	string	no	Name of the phase. Maximum supported length for name is 256 character.
`job_name`	string	no	Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
`metric_names`	string	no	query parameter `metricNames`.
`group_by_node`	boolean	no	Group summary for each node of the pipleine heirarchy
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultdetailsbybuild Write

GET /{organization}/{project}/_apis/testresults/resultdetailsbybuild Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultdetailsbybuild (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultdetailsbybuild
Full name: azure-devops.azure_devops_test_results_resultdetailsbybuild_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`publish_context`	string	no	query parameter `publishContext`.
`group_by`	string	no	query parameter `groupBy`.
`filter`	string	no	query parameter `$filter`.
`orderby`	string	no	query parameter `$orderby`.
`should_include_results`	boolean	no	query parameter `shouldIncludeResults`.
`query_run_summary_for_in_progress`	boolean	no	query parameter `queryRunSummaryForInProgress`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultdetailsbyrelease Write

GET /{organization}/{project}/_apis/testresults/resultdetailsbyrelease Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultdetailsbyrelease (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultdetailsbyrelease
Full name: azure-devops.azure_devops_test_results_resultdetailsbyrelease_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	no	query parameter `releaseId`.
`release_env_id`	number	no	query parameter `releaseEnvId`.
`publish_context`	string	no	query parameter `publishContext`.
`group_by`	string	no	query parameter `groupBy`.
`filter`	string	no	query parameter `$filter`.
`orderby`	string	no	query parameter `$orderby`.
`should_include_results`	boolean	no	query parameter `shouldIncludeResults`.
`query_run_summary_for_in_progress`	boolean	no	query parameter `queryRunSummaryForInProgress`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultgroupsbybuild Write

GET /{organization}/{project}/_apis/testresults/resultgroupsbybuild Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultgroupsbybuild (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultgroupsbybuild
Full name: azure-devops.azure_devops_test_results_resultgroupsbybuild_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`publish_context`	string	no	query parameter `publishContext`.
`fields`	string	no	query parameter `fields`.
`continuation_token`	string	no	query parameter `continuationToken`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultgroupsbyrelease Write

GET /{organization}/{project}/_apis/testresults/resultgroupsbyrelease Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultgroupsbyrelease (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultgroupsbyrelease
Full name: azure-devops.azure_devops_test_results_resultgroupsbyrelease_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	no	query parameter `releaseId`.
`publish_context`	string	no	query parameter `publishContext`.
`release_env_id`	number	no	query parameter `releaseEnvId`.
`fields`	string	no	query parameter `fields`.
`continuation_token`	string	no	query parameter `continuationToken`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_results Write

POST /{organization}/{project}/_apis/testresults/results Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_results
Full name: azure-devops.azure_devops_test_results_results_get_test_results_by_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

post_organization_project_apis_testresults_results_history Write

POST /{organization}/{project}/_apis/testresults/results/history Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/history (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_results_history
Full name: azure-devops.azure_devops_test_results_history_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_results_query Write

POST /{organization}/{project}/_apis/testresults/results/query Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/query (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_results_query
Full name: azure-devops.azure_devops_test_results_results_get_test_results_by_query_wiql

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`include_result_details`	boolean	no	query parameter `includeResultDetails`.
`include_iteration_details`	boolean	no	query parameter `includeIterationDetails`.
`skip`	number	no	query parameter `$skip`.
`top`	number	no	query parameter `$top`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_test_result_meta_data_details_corresponding_testcasereferenceid Write

Get list of test Result meta data details for corresponding testcasereferenceId Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/resultmetadata (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_list_test_result_meta_data_details_corresponding_testcasereferenceid
Full name: azure-devops.azure_devops_test_results_result_meta_data_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestCaseReference Ids of the test Result to be queried, comma separated list of valid ids (limit no. of ids 200).
`project`	string	yes	Project ID or project name
`details_to_include`	string	no	Details to include with test results metadata. Default is None. Other values are FlakyIdentifiers.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

update_properties_test_result_meta_data Write

Update properties of test result meta data Official Azure DevOps REST API 7.2 endpoint: PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/resultmetadata/{testCaseReferenceId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.update_properties_test_result_meta_data
Full name: azure-devops.azure_devops_test_results_result_meta_data_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestResultMetaData update input TestResultMetaDataUpdateInput
`project`	string	yes	Project ID or project name
`test_case_reference_id`	number	yes	TestCaseReference Id of Test Result to be updated.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

get_history_test_method_using_testhistoryquery Write

Get history of a test method using TestHistoryQuery Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/testhistory (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_history_test_method_using_testhistoryquery
Full name: azure-devops.azure_devops_test_results_test_history_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestHistoryQuery to get history
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

query_test_result_workitems_based_filter Write

Query Test Result WorkItems based on filter Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/workitems (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.query_test_result_workitems_based_filter
Full name: azure-devops.azure_devops_test_results_workitems_query_test_result_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_category`	string	no	can take values Microsoft.BugCategory or all(for getting all workitems)
`automated_test_name`	string	no	query parameter `automatedTestName`.
`test_case_id`	number	no	query parameter `testCaseId`.
`max_complete_date`	string	no	query parameter `maxCompleteDate`.
`days`	number	no	query parameter `days`.
`work_item_count`	number	no	query parameter `$workItemCount`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_apis_testresults_resultsbybuild Write

GET /{organization}/{project}/_apis/testresults/resultsbybuild Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsbybuild (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultsbybuild
Full name: azure-devops.azure_devops_test_results_resultsbybuild_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`publish_context`	string	no	query parameter `publishContext`.
`outcomes`	string	no	query parameter `outcomes`.
`top`	number	no	query parameter `$top`.
`continuation_token`	string	no	query parameter `continuationToken`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_results Write

Get a list of results. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsbypipeline (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_list_results
Full name: azure-devops.azure_devops_test_results_resultsbypipeline_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	no	Pipeline Id. This is same as build Id.
`stage_name`	string	no	Name of the stage. Maximum supported length for name is 256 character.
`phase_name`	string	no	Name of the phase. Maximum supported length for name is 256 character.
`job_name`	string	no	Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
`outcomes`	string	no	List of outcome of results
`include_all_build_runs`	boolean	no	Whether to include Test Runs from from all the build runs or not.
`top`	number	no	Maximum number of results to return
`continuation_token`	string	no	Header to pass the continuationToken
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultsbyrelease Write

GET /{organization}/{project}/_apis/testresults/resultsbyrelease Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsbyrelease (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultsbyrelease
Full name: azure-devops.azure_devops_test_results_resultsbyrelease_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	no	query parameter `releaseId`.
`release_envid`	number	no	query parameter `releaseEnvid`.
`publish_context`	string	no	query parameter `publishContext`.
`outcomes`	string	no	query parameter `outcomes`.
`top`	number	no	query parameter `$top`.
`continuation_token`	string	no	query parameter `continuationToken`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_available_groups_details_and_these_groups_get_failed_and_aborted_results Write

Get all the available groups details and for these groups get failed and aborted results. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsgroupdetails (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_all_available_groups_details_and_these_groups_get_failed_and_aborted_results
Full name: azure-devops.azure_devops_test_results_resultsgroup_details_test_results_group_details

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	no	Pipeline Id. This is same as build Id.
`stage_name`	string	no	Name of the stage. Maximum supported length for name is 256 character.
`phase_name`	string	no	Name of the phase. Maximum supported length for name is 256 character.
`job_name`	string	no	Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
`should_include_failed_and_aborted_results`	boolean	no	If true, it will return Ids of failed and aborted results for each test group
`query_group_summary_for_in_progress`	boolean	no	If true, it will calculate summary for InProgress runs as well.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultsummarybybuild Write

GET /{organization}/{project}/_apis/testresults/resultsummarybybuild Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsummarybybuild (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultsummarybybuild
Full name: azure-devops.azure_devops_test_results_resultsummarybybuild_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	query parameter `buildId`.
`publish_context`	string	no	query parameter `publishContext`.
`include_failure_details`	boolean	no	query parameter `includeFailureDetails`.
`build_to_compare_branch_name`	string	no	Branch name.
`build_to_compare_build_system`	string	no	Build system.
`build_to_compare_definition_id`	number	no	Build Definition ID.
`build_to_compare_id`	number	no	Build ID.
`build_to_compare_number`	string	no	Build Number.
`build_to_compare_repository_id`	string	no	Repository ID.
`build_to_compare_uri`	string	no	Build URI.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_summary_test_results Write

Get summary of test results. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsummarybypipeline (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_summary_test_results
Full name: azure-devops.azure_devops_test_results_resultsummarybypipeline_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`pipeline_id`	number	no	Pipeline Id. This is same as build Id.
`stage_name`	string	no	Name of the stage. Maximum supported length for name is 256 character.
`phase_name`	string	no	Name of the phase. Maximum supported length for name is 256 character.
`job_name`	string	no	Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
`include_failure_details`	boolean	no	If true returns failure insights
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_resultsummarybyrelease Write

GET /{organization}/{project}/_apis/testresults/resultsummarybyrelease Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsummarybyrelease (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_resultsummarybyrelease
Full name: azure-devops.azure_devops_test_results_resultsummarybyrelease_query_test_results_report_for_release

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`release_id`	number	no	query parameter `releaseId`.
`release_env_id`	number	no	query parameter `releaseEnvId`.
`publish_context`	string	no	query parameter `publishContext`.
`include_failure_details`	boolean	no	query parameter `includeFailureDetails`.
`release_to_compare_attempt`	number	no	Number of Release Attempt.
`release_to_compare_creation_date`	string	no	Release Creation Date(UTC).
`release_to_compare_definition_id`	number	no	Release definition ID.
`release_to_compare_environment_creation_date`	string	no	Environment creation Date(UTC).
`release_to_compare_environment_definition_id`	number	no	Release environment definition ID.
`release_to_compare_environment_definition_name`	string	no	Release environment definition name.
`release_to_compare_environment_id`	number	no	Release environment ID.
`release_to_compare_environment_name`	string	no	Release environment name.
`release_to_compare_id`	number	no	Release ID.
`release_to_compare_name`	string	no	Release name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_resultsummarybyrelease Write

POST /{organization}/{project}/_apis/testresults/resultsummarybyrelease Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsummarybyrelease (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_resultsummarybyrelease
Full name: azure-devops.azure_devops_test_results_resultsummarybyrelease_query_test_results_summary_for_releases

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_resultsummarybyrequirement Write

POST /{organization}/{project}/_apis/testresults/resultsummarybyrequirement Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsummarybyrequirement (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_resultsummarybyrequirement
Full name: azure-devops.azure_devops_test_results_resultsummarybyrequirement_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`work_item_ids`	string	no	query parameter `workItemIds`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_resulttrendbybuild Write

POST /{organization}/{project}/_apis/testresults/resulttrendbybuild Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resulttrendbybuild (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_resulttrendbybuild
Full name: azure-devops.azure_devops_test_results_result_trend_by_build_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_resulttrendbyrelease Write

POST /{organization}/{project}/_apis/testresults/resulttrendbyrelease Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resulttrendbyrelease (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_resulttrendbyrelease
Full name: azure-devops.azure_devops_test_results_result_trend_by_release_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs Write

GET /{organization}/{project}/_apis/testresults/runs Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs
Full name: azure-devops.azure_devops_test_results_runs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_uri`	string	no	query parameter `buildUri`.
`owner`	string	no	query parameter `owner`.
`tmi_run_id`	string	no	query parameter `tmiRunId`.
`plan_id`	number	no	query parameter `planId`.
`include_run_details`	boolean	no	query parameter `includeRunDetails`.
`automated`	boolean	no	query parameter `automated`.
`skip`	number	no	query parameter `$skip`.
`top`	number	no	query parameter `$top`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_runs Write

POST /{organization}/{project}/_apis/testresults/runs Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_runs
Full name: azure-devops.azure_devops_test_results_runs_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs_runid Write

GET /{organization}/{project}/_apis/testresults/runs/{runId} Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid
Full name: azure-devops.azure_devops_test_results_runs_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`include_details`	boolean	no	query parameter `includeDetails`.
`include_tags`	boolean	no	query parameter `includeTags`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_project_apis_testresults_runs_runid Write

PATCH /{organization}/{project}/_apis/testresults/runs/{runId} Official Azure DevOps REST API 7.2 endpoint: PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.patch_organization_project_apis_testresults_runs_runid
Full name: azure-devops.azure_devops_test_results_runs_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_project_apis_testresults_runs_runid Write

DELETE /{organization}/{project}/_apis/testresults/runs/{runId} Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.delete_organization_project_apis_testresults_runs_runid
Full name: azure-devops.azure_devops_test_results_runs_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs_runid_attachments Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/attachments Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/attachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_attachments
Full name: azure-devops.azure_devops_test_results_attachments_get_test_run_attachments

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_runs_runid_attachments Write

POST /{organization}/{project}/_apis/testresults/runs/{runId}/attachments Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/attachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_runs_runid_attachments
Full name: azure-devops.azure_devops_test_results_attachments_create_test_run_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_test_run_attachment Write

Returns a test run attachment Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/attachments/{attachmentId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_test_run_attachment
Full name: azure-devops.azure_devops_test_results_attachments_get_test_run_attachment_zip

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`attachment_id`	number	yes	path parameter `attachmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_project_apis_testresults_runs_runid_attachments_attachmentid Write

DELETE /{organization}/{project}/_apis/testresults/runs/{runId}/attachments/{attachmentId} Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/attachments/{attachmentId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.delete_organization_project_apis_testresults_runs_runid_attachments_attachmentid
Full name: azure-devops.azure_devops_test_results_attachments_delete_test_run_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`attachment_id`	number	yes	path parameter `attachmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs_runid_codecoverage Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/codecoverage Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/codecoverage (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_codecoverage
Full name: azure-devops.azure_devops_test_results_codecoverage_get_test_run_code_coverage

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`flags`	number	no	query parameter `flags`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_run_message_logs Write

Get test run message logs Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/messagelogs (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_test_run_message_logs
Full name: azure-devops.azure_devops_test_results_message_logs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_runs_runid_resultdocument Write

POST /{organization}/{project}/_apis/testresults/runs/{runId}/resultdocument Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/resultdocument (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_runs_runid_resultdocument
Full name: azure-devops.azure_devops_test_results_result_document_publish_test_result_document

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs_runid_results Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/results Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_results
Full name: azure-devops.azure_devops_test_results_results_get_test_results

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`details_to_include`	string	no	query parameter `detailsToInclude`.
`skip`	number	no	query parameter `$skip`.
`top`	number	no	query parameter `$top`.
`outcomes`	string	no	query parameter `outcomes`.
`new_tests_only`	boolean	no	query parameter `$newTestsOnly`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

post_organization_project_apis_testresults_runs_runid_results Write

POST /{organization}/{project}/_apis/testresults/runs/{runId}/results Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_runs_runid_results
Full name: azure-devops.azure_devops_test_results_results_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

patch_organization_project_apis_testresults_runs_runid_results Write

PATCH /{organization}/{project}/_apis/testresults/runs/{runId}/results Official Azure DevOps REST API 7.2 endpoint: PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.patch_organization_project_apis_testresults_runs_runid_results
Full name: azure-devops.azure_devops_test_results_results_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_test_result_attachments_reference Write

Get list of test result attachments reference Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{resultId}/testlog (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_list_test_result_attachments_reference
Full name: azure-devops.azure_devops_test_results_testlog_get_test_result_logs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Id of the test run that contains the result
`result_id`	number	yes	Id of the test result
`type`	string	no	type of attachments to get
`directory_path`	string	no	directory path of attachments to get
`file_name_prefix`	string	no	file name prefix to filter the list of attachment
`fetch_meta_data`	boolean	no	Default is false, set if metadata is needed
`top`	number	no	Numbe of attachments reference to return
`continuation_token`	string	no	Header to pass the continuationToken
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_sas_uri_test_results_attachment Write

Get SAS Uri of a test results attachment Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{resultId}/testlogstoreendpoint (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_sas_uri_test_results_attachment
Full name: azure-devops.azure_devops_test_results_testlogstoreendpoint_get_test_log_store_endpoint_details_for_result_log

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Id of the test run that contains result
`result_id`	number	yes	Id of the test result whose files need to be downloaded
`type`	string	no	type of the file
`file_path`	string	no	filePath for which sas uri is needed
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_empty_file_result_and_get_sas_uri_file Write

Create empty file for a result and Get Sas uri for the file Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{resultId}/testlogstoreendpoint (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.create_empty_file_result_and_get_sas_uri_file
Full name: azure-devops.azure_devops_test_results_testlogstoreendpoint_test_log_store_endpoint_details_for_result

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Id of the test run that contains the result
`result_id`	number	yes	Id of the test results that contains sub result
`sub_result_id`	number	no	Id of the test sub result whose file sas uri is needed
`file_path`	string	no	file path inside the sub result for which sas uri is needed
`type`	string	no	Type of the file for download
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

get_organization_project_apis_testresults_runs_runid_results_testcaseresultid_attachments Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_results_testcaseresultid_attachments
Full name: azure-devops.azure_devops_test_results_attachments_get_test_result_attachments

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_case_result_id`	number	yes	path parameter `testCaseResultId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_runs_runid_results_testcaseresultid_attachments Write

POST /{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_runs_runid_results_testcaseresultid_attachments
Full name: azure-devops.azure_devops_test_results_attachments_create_test_result_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_case_result_id`	number	yes	path parameter `testCaseResultId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_test_result_attachment Write

Returns a test result attachment Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments/{attachmentId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_test_result_attachment
Full name: azure-devops.azure_devops_test_results_attachments_get_test_result_attachment_zip

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_case_result_id`	number	yes	path parameter `testCaseResultId`.
`attachment_id`	number	yes	path parameter `attachmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_project_apis_testresults_runs_runid_results_testcaseresultid_attachments_attachmentid Write

DELETE /{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments/{attachmentId} Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/attachments/{attachmentId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.delete_organization_project_apis_testresults_runs_runid_results_testcaseresultid_attachments_attachmentid
Full name: azure-devops.azure_devops_test_results_attachments_delete_test_result_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_case_result_id`	number	yes	path parameter `testCaseResultId`.
`attachment_id`	number	yes	path parameter `attachmentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs_runid_results_testcaseresultid_bugs Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/bugs Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/bugs (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_results_testcaseresultid_bugs
Full name: azure-devops.azure_devops_test_results_bugs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_case_result_id`	number	yes	path parameter `testCaseResultId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_testresults_runs_runid_results_testcaseresultid_workitems Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/workitems Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testCaseResultId}/workitems (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_results_testcaseresultid_workitems
Full name: azure-devops.azure_devops_test_results_workitems_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_case_result_id`	number	yes	path parameter `testCaseResultId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_apis_testresults_runs_runid_results_testresultid Write

GET /{organization}/{project}/_apis/testresults/runs/{runId}/results/{testResultId} Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testResultId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_runs_runid_results_testresultid
Full name: azure-devops.azure_devops_test_results_results_get_test_result_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	path parameter `runId`.
`test_result_id`	number	yes	path parameter `testResultId`.
`details_to_include`	string	no	query parameter `detailsToInclude`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_list_results_whose_failure_matches_with_provided_one Write

Gets the list of results whose failure matches with the provided one. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/results/{testResultId}/similartestresults (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.gets_list_results_whose_failure_matches_with_provided_one
Full name: azure-devops.azure_devops_test_results_similar_test_results_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	id of test run
`test_result_id`	number	yes	id of test result inside a test run
`test_sub_result_id`	number	no	id of subresult inside a test result
`top`	number	no	Maximum number of results to return
`continuation_token`	string	no	Header to pass the continuationToken
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_run_summary_used_when_we_want_get_summary_run_by_outcome_test_run_should_be_completed_state Write

Get test run summary, used when we want to get summary of a run by outcome. Test run should be in completed state. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/runsummary (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_test_run_summary_used_when_we_want_get_summary_run_by_outcome_test_run_should_be_completed_state
Full name: azure-devops.azure_devops_test_results_runsummary_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_test_run_statistics_used_when_we_want_get_summary_run_by_outcome Write

Get test run statistics , used when we want to get summary of a run by outcome. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/statistics (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_test_run_statistics_used_when_we_want_get_summary_run_by_outcome
Full name: azure-devops.azure_devops_test_results_statistics_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	ID of the run to get.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_tags_run_tags_can_be_added_and_deleted Write

Update tags of a run, Tags can be Added and Deleted Official Azure DevOps REST API 7.2 endpoint: PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/tags (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.update_tags_run_tags_can_be_added_and_deleted
Full name: azure-devops.azure_devops_test_results_tags_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TestTagsUpdateModel
`project`	string	yes	Project ID or project name
`run_id`	number	yes	RunId of the run
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_attachments_specified_runid_from_logstore Write

Returns a list of attachments for the specified runId from the LogStore. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/testattachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_list_attachments_specified_runid_from_logstore
Full name: azure-devops.azure_devops_test_results_testattachments_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test RunId
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_attachment_logstore_specified_runid Write

Creates an attachment in the LogStore for the specified runId. Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/testattachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.creates_attachment_logstore_specified_runid
Full name: azure-devops.azure_devops_test_results_testattachments_create_test_run_log_store_attachment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Contains attachment info like stream, filename, comment, attachmentType
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test RunId
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_attachment_with_specified_filename_specified_runid_from_logstore Write

Deletes the attachment with the specified filename for the specified runId from the LogStore. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/testattachments (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.deletes_attachment_with_specified_filename_specified_runid_from_logstore
Full name: azure-devops.azure_devops_test_results_testattachments_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Test RunId
`filename`	string	no	Attachment FileName
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_test_run_attachments_reference Write

Get list of test run attachments reference Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/testlog (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_list_test_run_attachments_reference
Full name: azure-devops.azure_devops_test_results_testlog_get_test_run_logs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Id of the test run
`type`	string	no	type of the attachments to get
`directory_path`	string	no	directory path for which attachments are needed
`file_name_prefix`	string	no	file name prefix to filter the list of attachment
`fetch_meta_data`	boolean	no	Default is false, set if metadata is needed
`top`	number	no	Number of attachments reference to return
`continuation_token`	string	no	Header to pass the continuationToken
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_sas_uri_test_run_attachment Write

Get SAS Uri of a test run attachment Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/testlogstoreendpoint (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_sas_uri_test_run_attachment
Full name: azure-devops.azure_devops_test_results_testlogstoreendpoint_get_test_log_store_endpoint_details_for_run_log

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Id of the test run whose file has to be downloaded
`type`	string	no	type of the file
`file_path`	string	no	filePath for which sas uri is needed
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_empty_file_run_and_get_sas_uri_file Write

Create empty file for a run and Get Sas uri for the file Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs/{runId}/testlogstoreendpoint (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.create_empty_file_run_and_get_sas_uri_file
Full name: azure-devops.azure_devops_test_results_testlogstoreendpoint_test_log_store_endpoint_details_for_run

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`run_id`	number	yes	Id of the run to get endpoint details
`test_log_store_operation_type`	string	no	Type of operation to perform using sas uri
`file_path`	string	no	file path to create an empty file
`type`	string	no	Default is GeneralAttachment, type of empty file to be created
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

get_testresultssettings_data Write

Get TestResultsSettings data Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/settings (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_testresultssettings_data
Full name: azure-devops.azure_devops_test_results_settings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`settings_type`	string	no	query parameter `settingsType`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_project_settings_test_results Write

Update project settings of test results Official Azure DevOps REST API 7.2 endpoint: PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/settings (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.update_project_settings_test_results
Full name: azure-devops.azure_devops_test_results_settings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_all_tags_build Write

Get all the tags in a build. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/tags (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_all_tags_build
Full name: azure-devops.azure_devops_test_results_tags_get_test_tags_for_build

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	Build ID
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_tags_build Write

Get all the tags in a build. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/tagsummary (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_all_tags_build
Full name: azure-devops.azure_devops_test_results_tagsummary_get_test_tag_summary_for_build

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	Build ID
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

oauth_callback_endpoint_github_redirects_here_after_user_authorizes_exchanges_authorization_code_tokens_and_stores_them_tcm_strongbox_requires_callback_url_be_registered_github_oauth_app_settings

Write

OAuth callback endpoint. GitHub redirects here after user authorizes. Exchanges the authorization code for tokens and stores them in TCM StrongBox. Requires the callback URL to be registered in the GitHub OAuth App settings. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testai/completegithubauth (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.oauth_callback_endpoint_github_redirects_here_after_user_authorizes_exchanges_authorization_code_tokens_and_stores_them_tcm_strongbox_requires_callback_url_be_registered_github_oauth_app_settings
Full name: azure-devops.azure_devops_test_results_testai_complete_git_hub_auth

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`code`	string	no	The authorization code returned by GitHub after user consent
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_test_failure_types Write

Returns the list of test failure types. Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testfailuretype (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.returns_list_test_failure_types
Full name: azure-devops.azure_devops_test_results_testfailuretype_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_new_test_failure_type Write

Creates a new test failure type Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testfailuretype (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.creates_new_test_failure_type
Full name: azure-devops.azure_devops_test_results_testfailuretype_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_test_failure_type_with_specified_failuretypeid Write

Deletes a test failure type with specified failureTypeId Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testfailuretype/{failureTypeId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.deletes_test_failure_type_with_specified_failuretypeid
Full name: azure-devops.azure_devops_test_results_testfailuretype_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`failure_type_id`	number	yes	path parameter `failureTypeId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_build_attachments_reference Write

Get list of build attachments reference Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testlog (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_list_build_attachments_reference
Full name: azure-devops.azure_devops_test_results_testlog_get_test_logs_for_build

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	Id of the build to get
`type`	string	no	type of the attachment to get
`directory_path`	string	no	directory path for which attachments are needed
`file_name_prefix`	string	no	file name prefix to filter the list of attachment
`fetch_meta_data`	boolean	no	Default is false, set if metadata is needed
`top`	number	no	Number of test attachments reference to return
`continuation_token`	string	no	Header to pass the continuationToken
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_sas_uri_build_attachment Write

Get SAS Uri of a build attachment Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testlogstoreendpoint (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_sas_uri_build_attachment
Full name: azure-devops.azure_devops_test_results_testlogstoreendpoint_get_test_log_store_endpoint_details_for_build_log

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build`	number	no	Id of the build to get
`type`	string	no	type of the file
`file_path`	string	no	filePath for which sas uri is needed
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

create_and_get_sas_uri_build_container Write

Create and Get sas uri of the build container Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testlogstoreendpoint (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.create_and_get_sas_uri_build_container
Full name: azure-devops.azure_devops_test_results_testlogstoreendpoint_test_log_store_endpoint_details_for_build

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`build_id`	number	no	Id of the build to get
`test_log_store_operation_type`	string	no	Type of operation to perform using sas uri
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

post_organization_project_apis_testresults_testmethods_workitems Write

POST /{organization}/{project}/_apis/testresults/testmethods/workitems Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testmethods/workitems (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_testmethods_workitems
Full name: azure-devops.azure_devops_test_results_workitems_add

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_organization_project_apis_testresults_testmethods_workitems Write

DELETE /{organization}/{project}/_apis/testresults/testmethods/workitems Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testmethods/workitems (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.delete_organization_project_apis_testresults_testmethods_workitems
Full name: azure-devops.azure_devops_test_results_workitems_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_name`	string	no	query parameter `testName`.
`work_item_id`	number	no	query parameter `workItemId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_apis_testresults_testsettings Write

GET /{organization}/{project}/_apis/testresults/testsettings Official Azure DevOps REST API 7.2 endpoint: GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testsettings (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_testresults_testsettings
Full name: azure-devops.azure_devops_test_results_testsettings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_settings_id`	number	no	query parameter `testSettingsId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

post_organization_project_apis_testresults_testsettings Write

POST /{organization}/{project}/_apis/testresults/testsettings Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testsettings (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.post_organization_project_apis_testresults_testsettings
Full name: azure-devops.azure_devops_test_results_testsettings_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_organization_project_apis_testresults_testsettings Write

DELETE /{organization}/{project}/_apis/testresults/testsettings Official Azure DevOps REST API 7.2 endpoint: DELETE https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/testsettings (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.delete_organization_project_apis_testresults_testsettings
Full name: azure-devops.azure_devops_test_results_testsettings_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`test_settings_id`	number	no	query parameter `testSettingsId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_attachment_logstore_specified_buildid Write

Creates an attachment in the LogStore for the specified buildId. Official Azure DevOps REST API 7.2 endpoint: POST https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/uploadbuildattachments/{buildId} (spec: testResults/7.2/testResults.json).

Lua path: app.integrations.azure_devops.creates_attachment_logstore_specified_buildid
Full name: azure-devops.azure_devops_test_results_testattachments_create_build_attachment_in_log_store

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Contains attachment info like stream, filename, comment, attachmentType
`project`	string	yes	Project ID or project name
`build_id`	number	yes	BuildId
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_tfvc_changes_given_changeset Read

Retrieve Tfvc changes for a given changeset. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/{id}/changes (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.retrieve_tfvc_changes_given_changeset
Full name: azure-devops.azure_devops_tfvc_changesets_get_changeset_changes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	ID of the changeset. Default: null
`skip`	number	no	Number of results to skip. Default: null
`top`	number	no	The maximum number of results to return. Default: null
`continuation_token`	string	no	Return the next page of results. Default: null
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieves_work_items_associated_with_particular_changeset Read

Retrieves the work items associated with a particular changeset. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/{id}/workItems (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.retrieves_work_items_associated_with_particular_changeset
Full name: azure-devops.azure_devops_tfvc_changesets_get_changeset_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	ID of the changeset.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_changesets_given_list_changeset_ids Read

Returns changesets for a given list of changeset Ids. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/_apis/tfvc/changesetsbatch (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.returns_changesets_given_list_changeset_ids
Full name: azure-devops.azure_devops_tfvc_changesets_get_batched_changesets

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of changeset IDs.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_items_under_label Read

Get items under a label. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/tfvc/labels/{labelId}/items (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_items_under_label
Full name: azure-devops.azure_devops_tfvc_labels_get_label_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`label_id`	string	yes	Unique identifier of label
`top`	number	no	Max number of items to return
`skip`	number	no	Number of items to skip
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_single_deep_shelveset Read

Get a single deep shelveset. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/tfvc/shelvesets (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_single_deep_shelveset
Full name: azure-devops.azure_devops_tfvc_shelvesets_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`shelveset_id`	string	no	Shelveset's unique ID
`request_data_include_details`	boolean	no	Whether to include policyOverride and notes Only applies when requesting a single deep shelveset
`request_data_include_links`	boolean	no	Whether to include the _links field on the shallow references. Does not apply when requesting a single deep shelveset object. Links will always be included in the deep shelveset.
`request_data_include_work_items`	boolean	no	Whether to include workItems
`request_data_max_change_count`	number	no	Max number of changes to include
`request_data_max_comment_length`	number	no	Max length of comment
`request_data_name`	string	no	Shelveset name
`request_data_owner`	string	no	Owner's ID. Could be a name or a guid.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_changes_included_shelveset Read

Get changes included in a shelveset. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/tfvc/shelvesets/changes (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_changes_included_shelveset
Full name: azure-devops.azure_devops_tfvc_shelvesets_get_shelveset_changes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`shelveset_id`	string	no	Shelveset's unique ID
`top`	number	no	Max number of changes to return
`skip`	number	no	Number of changes to skip
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_work_items_associated_with_shelveset Read

Get work items associated with a shelveset. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/tfvc/shelvesets/workitems (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_work_items_associated_with_shelveset
Full name: azure-devops.azure_devops_tfvc_shelvesets_get_shelveset_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`shelveset_id`	string	no	Shelveset's unique ID
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_branch_hierarchies_below_specified_scopepath Read

Get branch hierarchies below the specified scopePath Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/branches (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_branch_hierarchies_below_specified_scopepath
Full name: azure-devops.azure_devops_tfvc_branches_get_branch_refs

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`scope_path`	string	no	Full path to the branch. Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.
`project`	string	yes	Project ID or project name
`include_deleted`	boolean	no	Return deleted branches. Default: False
`include_links`	boolean	no	Return links. Default: False
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieve_tfvc_changesets_note_this_is_new_version_getchangesets_api_that_doesn_t_expose_unneeded_queryparams_present_1_0_version_api

Read

Retrieve Tfvc Changesets Note: This is a new version of the GetChangesets API that doesn't expose the unneeded queryParams present in the 1.0 version of the API. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/changesets (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.retrieve_tfvc_changesets_note_this_is_new_version_getchangesets_api_that_doesn_t_expose_unneeded_queryparams_present_1_0_version_api
Full name: azure-devops.azure_devops_tfvc_changesets_get_changesets

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`max_comment_length`	number	no	Include details about associated work items in the response. Default: null
`skip`	number	no	Number of results to skip. Default: null
`top`	number	no	The maximum number of results to return. Default: null
`orderby`	string	no	Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.
`search_criteria_author`	string	no	Alias or display name of user who made the changes.
`search_criteria_follow_renames`	boolean	no	Whether or not to follow renames for the given item being queried.
`search_criteria_from_date`	string	no	If provided, only include changesets created after this date (string).
`search_criteria_from_id`	number	no	If provided, only include changesets after this changesetID.
`search_criteria_include_links`	boolean	no	Whether to include the _links field on the shallow references.
`search_criteria_item_path`	string	no	Path of item to search under.
`search_criteria_mappings`	array	no	Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null
`search_criteria_to_date`	string	no	If provided, only include changesets created before this date (string).
`search_criteria_to_id`	number	no	If provided, a version descriptor for the latest change list to include.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

create_new_changeset_accepts_tfvcchangeset_json_body Read

Create a new changeset. Accepts TfvcChangeset as JSON body Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/tfvc/changesets (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.create_new_changeset_accepts_tfvcchangeset_json_body
Full name: azure-devops.azure_devops_tfvc_changesets_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

retrieve_tfvc_changeset Read

Retrieve a Tfvc Changeset Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/changesets/{id} (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.retrieve_tfvc_changeset
Full name: azure-devops.azure_devops_tfvc_changesets_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	Changeset Id to retrieve.
`project`	string	yes	Project ID or project name
`max_change_count`	number	no	Number of changes to return (maximum 100 changes) Default: 0
`include_details`	boolean	no	Include policy details and check-in notes in the response. Default: false
`include_work_items`	boolean	no	Include workitems. Default: false
`max_comment_length`	number	no	Include details about associated work items in the response. Default: null
`include_source_rename`	boolean	no	Include renames. Default: false
`skip`	number	no	Number of results to skip. Default: null
`top`	number	no	The maximum number of results to return. Default: null
`orderby`	string	no	Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.
`search_criteria_author`	string	no	Alias or display name of user who made the changes.
`search_criteria_follow_renames`	boolean	no	Whether or not to follow renames for the given item being queried.
`search_criteria_from_date`	string	no	If provided, only include changesets created after this date (string).
`search_criteria_from_id`	number	no	If provided, only include changesets after this changesetID.
`search_criteria_include_links`	boolean	no	Whether to include the _links field on the shallow references.
`search_criteria_item_path`	string	no	Path of item to search under.
`search_criteria_mappings`	array	no	Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null
`search_criteria_to_date`	string	no	If provided, only include changesets created before this date (string).
`search_criteria_to_id`	number	no	If provided, a version descriptor for the latest change list to include.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

post_retrieving_set_items_given_list_paths_or_long_path_allows_specifying_recursionlevel_and_version_descriptors_each_path

Read

Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/tfvc/itembatch (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.post_retrieving_set_items_given_list_paths_or_long_path_allows_specifying_recursionlevel_and_version_descriptors_each_path
Full name: azure-devops.azure_devops_tfvc_items_get_items_batch

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_tfvc_items Read

Get a list of Tfvc items Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_list_tfvc_items
Full name: azure-devops.azure_devops_tfvc_items_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`scope_path`	string	no	Version control path of a folder to return multiple items.
`recursion_level`	string	no	None (just the item), or OneLevel (contents of a folder).
`include_links`	boolean	no	True to include links.
`version_descriptor_version`	string	no	Version object.
`version_descriptor_version_option`	string	no	query parameter `versionDescriptor.versionOption`.
`version_descriptor_version_type`	string	no	query parameter `versionDescriptor.versionType`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_collection_shallow_label_references Read

Get a collection of shallow label references. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/labels (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_collection_shallow_label_references
Full name: azure-devops.azure_devops_tfvc_labels_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`request_data_include_links`	boolean	no	Whether to include the _links field on the shallow references
`request_data_item_label_filter`	string	no	labelScope, name, owner, and itemLabelFilter
`request_data_label_scope`	string	no	labelScope, name, owner, and itemLabelFilter
`request_data_max_item_count`	number	no	labelScope, name, owner, and itemLabelFilter
`request_data_name`	string	no	labelScope, name, owner, and itemLabelFilter
`request_data_owner`	string	no	labelScope, name, owner, and itemLabelFilter
`top`	number	no	Max number of labels to return, defaults to 100 when undefined
`skip`	number	no	Number of labels to skip
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_single_deep_label Read

Get a single deep label. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/labels/{labelId} (spec: tfvc/7.2/tfvc.json).

Lua path: app.integrations.azure_devops.get_single_deep_label
Full name: azure-devops.azure_devops_tfvc_labels_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`label_id`	string	yes	Unique identifier of label
`project`	string	yes	Project ID or project name
`request_data_include_links`	boolean	no	Whether to include the _links field on the shallow references
`request_data_item_label_filter`	string	no	maxItemCount
`request_data_label_scope`	string	no	maxItemCount
`request_data_max_item_count`	number	no	maxItemCount
`request_data_name`	string	no	maxItemCount
`request_data_owner`	string	no	maxItemCount
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

lists_all_session_token_details_personal_access_tokens_pats_particular_user Read

Lists of all the session token details of the personal access tokens (PATs) for a particular user. Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/tokenadmin/personalaccesstokens/{subjectDescriptor} (spec: tokenAdmin/7.2/tokenAdmin.json).

Lua path: app.integrations.azure_devops.lists_all_session_token_details_personal_access_tokens_pats_particular_user
Full name: azure-devops.azure_devops_token_admin_personal_access_tokens_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`subject_descriptor`	string	yes	The descriptor of the target user.
`page_size`	number	no	The maximum number of results to return on each page.
`continuation_token`	string	no	An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
`is_public`	boolean	no	Set to false for PAT tokens and true for SSH tokens.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_revocation_rule_prevent_further_usage_any_oauth_authorizations_that_were_created_before_current_point_time_and_which_match_conditions_rule_not_all_kinds_oauth_authorizations_can_be_revoked_directly_some_such_self_describing_session_tokens_must_instead_by_revoked_by_creating_rule_which_will_be_evaluated_and_used_reject_matching_oauth_credentials_at_authentication_time_revocation_rules_created_through_this_endpoint_will_apply_all_credentials_that_were_issued_before_datetime_at_which_rule_was_created_and_which_match_one_or_more_additional_conditions

Read

Creates a revocation rule to prevent the further usage of any OAuth authorizations that were created before the current point in time and which match the conditions in the rule. Not all kinds of OAuth authorizations can be revoked directly. Some, such as self-describing session tokens, must instead by revoked by creating a rule which will be evaluated and used to reject matching OAuth credentials at authentication time. Revocation rules created through this endpoint will apply to all credentials that were issued before the datetime at which the rule was created and which match one or more additional conditions. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/tokenadmin/revocationrules (spec: tokenAdmin/7.2/tokenAdmin.json).

Lua path: app.integrations.azure_devops.creates_revocation_rule_prevent_further_usage_any_oauth_authorizations_that_were_created_before_current_point_time_and_which_match_conditions_rule_not_all_kinds_oauth_authorizations_can_be_revoked_directly_some_such_self_describing_session_tokens_must_instead_by_revoked_by_creating_rule_which_will_be_evaluated_and_used_reject_matching_oauth_credentials_at_authentication_time_revocation_rules_created_through_this_endpoint_will_apply_all_credentials_that_were_issued_before_datetime_at_which_rule_was_created_and_which_match_one_or_more_additional_conditions
Full name: azure-devops.azure_devops_token_admin_revocation_rules_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The revocation rule to create. The rule must specify a space-separated list of scopes, after which preexisting OAuth authorizations that match that any of the scopes will be rejected. For a list of all OAuth scopes supported by VSTS, see: https://docs.microsoft.com/en-us/vsts/integrate/get-started/authentication/oauth?view=vsts#scopes The rule may also specify the time before which to revoke tokens.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

revokes_listed_oauth_authorizations Read

Revokes the listed OAuth authorizations. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/tokenadmin/revocations (spec: tokenAdmin/7.2/tokenAdmin.json).

Lua path: app.integrations.azure_devops.revokes_listed_oauth_authorizations
Full name: azure-devops.azure_devops_token_admin_revocations_revoke_authorizations

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The list of objects containing the authorization IDs of the OAuth authorizations, such as session tokens retrieved by listed a users PATs, that should be revoked.
`is_public`	boolean	no	Set to false for PAT tokens and true for SSH tokens.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_single_personal_access_token_pat Read

Gets a single personal access token (PAT). Official Azure DevOps REST API 7.2 endpoint: GET https://vssps.dev.azure.com/{organization}/_apis/tokens/pats (spec: tokens/7.2/tokens.json).

Lua path: app.integrations.azure_devops.gets_single_personal_access_token_pat
Full name: azure-devops.azure_devops_tokens_pats_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`authorization_id`	string	no	The authorizationId identifying a single, unique personal access token (PAT)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_new_personal_access_token_pat_requesting_user Read

Creates a new personal access token (PAT) for the requesting user. Official Azure DevOps REST API 7.2 endpoint: POST https://vssps.dev.azure.com/{organization}/_apis/tokens/pats (spec: tokens/7.2/tokens.json).

Lua path: app.integrations.azure_devops.creates_new_personal_access_token_pat_requesting_user
Full name: azure-devops.azure_devops_tokens_pats_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

updates_existing_personal_access_token_pat_with_new_parameters_update_token_it_must_be_valid_has_not_been_revoked Read

Updates an existing personal access token (PAT) with the new parameters. To update a token, it must be valid (has not been revoked). Official Azure DevOps REST API 7.2 endpoint: PUT https://vssps.dev.azure.com/{organization}/_apis/tokens/pats (spec: tokens/7.2/tokens.json).

Lua path: app.integrations.azure_devops.updates_existing_personal_access_token_pat_with_new_parameters_update_token_it_must_be_valid_has_not_been_revoked
Full name: azure-devops.azure_devops_tokens_pats_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

revokes_personal_access_token_pat_by_authorizationid Read

Revokes a personal access token (PAT) by authorizationId. Official Azure DevOps REST API 7.2 endpoint: DELETE https://vssps.dev.azure.com/{organization}/_apis/tokens/pats (spec: tokens/7.2/tokens.json).

Lua path: app.integrations.azure_devops.revokes_personal_access_token_pat_by_authorizationid
Full name: azure-devops.azure_devops_tokens_pats_revoke

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`authorization_id`	string	no	The authorizationId identifying a single, unique personal access token (PAT)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_all_wikis_project_or_collection Read

Gets all wikis in a project or collection. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.gets_all_wikis_project_or_collection
Full name: azure-devops.azure_devops_wiki_wikis_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_wiki_resource Read

Creates the wiki resource. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.creates_wiki_resource
Full name: azure-devops.azure_devops_wiki_wikis_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Parameters for the wiki creation.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_wiki_corresponding_wiki_id_or_wiki_name_provided Read

Gets the wiki corresponding to the wiki ID or wiki name provided. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier} (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.gets_wiki_corresponding_wiki_id_or_wiki_name_provided
Full name: azure-devops.azure_devops_wiki_wikis_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

updates_wiki_corresponding_wiki_id_or_wiki_name_provided_using_update_parameters Read

Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier} (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.updates_wiki_corresponding_wiki_id_or_wiki_name_provided_using_update_parameters
Full name: azure-devops.azure_devops_wiki_wikis_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Update parameters.
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

deletes_wiki_corresponding_wiki_id_or_wiki_name_provided Read

Deletes the wiki corresponding to the wiki ID or wiki name provided. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier} (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.deletes_wiki_corresponding_wiki_id_or_wiki_name_provided
Full name: azure-devops.azure_devops_wiki_wikis_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_attachment_wiki Read

Creates an attachment in the wiki. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/attachments (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.creates_attachment_wiki
Full name: azure-devops.azure_devops_wiki_attachments_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Raw payload: provide `content` as a string and optional `content_type`.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`name`	string	no	Wiki attachment name.
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_page_move_operation_that_updates_path_and_order_page_provided_parameters Read

Creates a page move operation that updates the path and order of the page as provided in the parameters. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagemoves (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.creates_page_move_operation_that_updates_path_and_order_page_provided_parameters
Full name: azure-devops.azure_devops_wiki_page_moves_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Page more operation parameters.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`comment`	string	no	Comment that is to be associated with this page move.
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_metadata_or_content_wiki_page_provided_path_content_negotiation_is_done_based_accept_header_sent_request Read

Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.gets_metadata_or_content_wiki_page_provided_path_content_negotiation_is_done_based_accept_header_sent_request
Full name: azure-devops.azure_devops_wiki_pages_get_page

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`path`	string	no	Wiki page path.
`recursion_level`	string	no	Recursion level for subpages retrieval. Defaults to `None` (Optional).
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`include_content`	boolean	no	True to include the content of the page in the response for Json content type. Defaults to false (Optional)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_or_edits_wiki_page Write

Creates or edits a wiki page. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.creates_or_edits_wiki_page
Full name: azure-devops.azure_devops_wiki_pages_create_or_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Wiki create or update operation parameters.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`path`	string	no	Wiki page path.
`version`	string	no	Version of the page on which the change is to be made. Mandatory for `Edit` scenario. To be populated in the If-Match header of the request.
`comment`	string	no	Comment to be associated with the page operation.
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_wiki_page Write

Deletes a wiki page. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.deletes_wiki_page
Full name: azure-devops.azure_devops_wiki_pages_delete_page

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`path`	string	no	Wiki page path.
`comment`	string	no	Comment to be associated with this page delete.
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_metadata_or_content_wiki_page_provided_page_id_content_negotiation_is_done_based_accept_header_sent_request Read

Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id} (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.gets_metadata_or_content_wiki_page_provided_page_id_content_negotiation_is_done_based_accept_header_sent_request
Full name: azure-devops.azure_devops_wiki_pages_get_page_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name..
`id`	number	yes	Wiki page ID.
`recursion_level`	string	no	Recursion level for subpages retrieval. Defaults to `None` (Optional).
`include_content`	boolean	no	True to include the content of the page in the response for Json content type. Defaults to false (Optional)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

edits_wiki_page Read

Edits a wiki page. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id} (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.edits_wiki_page
Full name: azure-devops.azure_devops_wiki_pages_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Wiki update operation parameters.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`id`	number	yes	Wiki page ID.
`version`	string	no	Version of the page on which the change is to be made. Mandatory for `Edit` scenario. To be populated in the If-Match header of the request.
`comment`	string	no	Comment to be associated with the page operation.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_wiki_page Write

Deletes a wiki page. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id} (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.deletes_wiki_page
Full name: azure-devops.azure_devops_wiki_pages_delete_page_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`id`	number	yes	Wiki page ID.
`comment`	string	no	Comment to be associated with this page delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_page_detail_corresponding_page_id Read

Returns page detail corresponding to Page ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{pageId}/stats (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.returns_page_detail_corresponding_page_id
Full name: azure-devops.azure_devops_wiki_page_stats_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`page_id`	number	yes	Wiki page ID.
`page_views_for_days`	number	no	last N days from the current day for which page views is to be returned. It's inclusive of current day.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_pageable_list_wiki_pages Read

Returns pageable list of Wiki Pages Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pagesbatch (spec: wiki/7.2/wiki.json).

Lua path: app.integrations.azure_devops.returns_pageable_list_wiki_pages
Full name: azure-devops.azure_devops_wiki_pages_batch_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Wiki batch page request.
`project`	string	yes	Project ID or project name
`wiki_identifier`	string	yes	Wiki ID or wiki name.
`version_descriptor_version`	string	no	Version string identifier (name of tag/branch, SHA1 of commit)
`version_descriptor_version_options`	string	no	Version options - Specify additional modifiers to version (e.g Previous)
`version_descriptor_version_type`	string	no	Version type (branch, tag, or commit). Determines how Id is interpreted
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_work_item_tracking_outbound_artifact_link_types Read

Get the list of work item tracking outbound artifact link types. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/wit/artifactlinktypes (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_list_work_item_tracking_outbound_artifact_link_types
Full name: azure-devops.azure_devops_wit_artifact_link_types_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_all_work_item_icons Read

Get a list of all work item icons. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/wit/workitemicons (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_list_all_work_item_icons
Full name: azure-devops.azure_devops_wit_work_item_icons_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_work_item_icon_given_friendly_name_and_icon_color Read

Get a work item icon given the friendly name and icon color. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/wit/workitemicons/{icon} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_work_item_icon_given_friendly_name_and_icon_color
Full name: azure-devops.azure_devops_wit_work_item_icons_get

Parameter	Type	Required	Description
`icon`	string	yes	The name of the icon
`organization`	string	yes	The name of the Azure DevOps organization.
`color`	string	no	The 6-digit hex color for the icon
`v`	number	no	The version of the icon (used only for cache invalidation)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_work_item_relation_types Read

Gets the work item relation types. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/wit/workitemrelationtypes (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_work_item_relation_types
Full name: azure-devops.azure_devops_wit_work_item_relation_types_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_work_item_relation_type_definition Read

Gets the work item relation type definition. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/wit/workitemrelationtypes/{relation} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_work_item_relation_type_definition
Full name: azure-devops.azure_devops_wit_work_item_relation_types_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`relation`	string	yes	The relation name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_next_state_given_work_item_ids Read

Returns the next state on the given work item IDs. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/wit/workitemtransitions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_next_state_given_work_item_ids
Full name: azure-devops.azure_devops_wit_work_item_transitions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`ids`	string	no	list of work item ids
`action`	string	no	possible actions. Currently only supports checkin
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_recent_work_item_activities Read

Gets recent work item activities Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/_apis/work/accountmyworkrecentactivity (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_recent_work_item_activities
Full name: azure-devops.azure_devops_wit_account_my_work_recent_activity_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_list_github_connections Read

Gets a list of github connections Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/githubconnections (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_list_github_connections
Full name: azure-devops.azure_devops_wit_github_connections_get_github_connections

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_repos_within_specified_github_connection Read

Gets a list of repos within specified github connection. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/githubconnections/{connectionId}/repos (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_list_repos_within_specified_github_connection
Full name: azure-devops.azure_devops_wit_github_connections_get_github_connection_repositories

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`connection_id`	string	yes	path parameter `connectionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_remove_list_repos_within_specified_github_connection Read

Add/remove list of repos within specified github connection. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/githubconnections/{connectionId}/reposBatch (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.add_remove_list_repos_within_specified_github_connection
Full name: azure-devops.azure_devops_wit_github_connections_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`connection_id`	string	yes	path parameter `connectionId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

queries_work_items_linked_given_list_artifact_uri Read

Queries work items linked to a given list of artifact URI. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/artifacturiquery (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.queries_work_items_linked_given_list_artifact_uri
Full name: azure-devops.azure_devops_wit_artifact_uri_query_query

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Defines a list of artifact URI for querying work items.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

uploads_attachment_accounts_with_higher_attachment_upload_limits_130mb_you_will_need_use_chunked_upload_upload_attachment_multiple_chunks_you_first_need_start_chunked_upload_start_chunked_upload_and_then_follow_example_from_upload_chunk_section

Read

Uploads an attachment. On accounts with higher attachment upload limits (>130MB), you will need to use chunked upload. To upload an attachment in multiple chunks, you first need to [**Start a Chunked Upload**](#start_a_chunked_upload) and then follow the example from the **Upload Chunk** section. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/attachments (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.uploads_attachment_accounts_with_higher_attachment_upload_limits_130mb_you_will_need_use_chunked_upload_upload_attachment_multiple_chunks_you_first_need_start_chunked_upload_start_chunked_upload_and_then_follow_example_from_upload_chunk_section
Full name: azure-devops.azure_devops_wit_attachments_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Raw payload: provide `content` as a string and optional `content_type`.
`project`	string	yes	Project ID or project name
`file_name`	string	no	The name of the file
`upload_type`	string	no	Attachment upload type: Simple or Chunked
`area_path`	string	no	Target project Area Path
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

downloads_attachment Read

Downloads an attachment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/attachments/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.downloads_attachment
Full name: azure-devops.azure_devops_wit_attachments_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	Attachment ID
`project`	string	yes	Project ID or project name
`file_name`	string	no	Name of the file
`download`	boolean	no	If set to <c>true</c> always download attachment
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

uploads_attachment_chunk_before_performing_upload_chunk_upload_chunk_make_sure_have_attachment_id_returned_start_chunked_upload_example_create_section_specify_byte_range_chunk_using_content_length_example_content_length_bytes_0_39999_50000_first_40000_bytes_50000_byte_file

Read

Uploads an attachment chunk. Before performing [**Upload a Chunk**](#upload-a-chunk), make sure to have an attachment id returned in **Start a Chunked Upload** example on **Create** section. Specify the byte range of the chunk using Content-Length. For example: "Content - Length": "bytes 0 - 39999 / 50000" for the first 40000 bytes of a 50000 byte file. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/wit/attachments/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.uploads_attachment_chunk_before_performing_upload_chunk_upload_chunk_make_sure_have_attachment_id_returned_start_chunked_upload_example_create_section_specify_byte_range_chunk_using_content_length_example_content_length_bytes_0_39999_50000_first_40000_bytes_50000_byte_file
Full name: azure-devops.azure_devops_wit_attachments_upload_chunk

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Raw payload: provide `content` as a string and optional `content_type`.
`id`	string	yes	The id of the attachment
`content_range_header`	string	no	starting and ending byte positions for chunked file upload, format is "Content-Range": "bytes 0-10000/50000"
`project`	string	yes	Project ID or project name
`file_name`	string	no	query parameter `fileName`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

permanently_delete_attachment Read

Permanently delete an attachment. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/attachments/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.permanently_delete_attachment
Full name: azure-devops.azure_devops_wit_attachments_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	Attachment ID
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

gets_root_classification_nodes_under_project Read

Gets root classification nodes under the project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_root_classification_nodes_under_project
Full name: azure-devops.azure_devops_wit_classification_nodes_get_root_nodes

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`depth`	number	no	Depth of children to fetch.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_classification_node_given_node_path Read

Gets the classification node for a given node path. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_classification_node_given_node_path
Full name: azure-devops.azure_devops_wit_classification_nodes_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`structure_group`	string	yes	Structure group of the classification node, area or iteration.
`path`	string	yes	Path of the classification node.
`depth`	number	no	Depth of children to fetch.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

create_new_or_update_existing_classification_node Write

Create new or update an existing classification node. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.create_new_or_update_existing_classification_node
Full name: azure-devops.azure_devops_wit_classification_nodes_create_or_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Node to create or update.
`project`	string	yes	Project ID or project name
`structure_group`	string	yes	Structure group of the classification node, area or iteration.
`path`	string	yes	Path of the classification node.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_existing_classification_node Read

Update an existing classification node. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.update_existing_classification_node
Full name: azure-devops.azure_devops_wit_classification_nodes_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Node to create or update.
`project`	string	yes	Project ID or project name
`structure_group`	string	yes	Structure group of the classification node, area or iteration.
`path`	string	yes	Path of the classification node.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_existing_classification_node Read

Delete an existing classification node. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.delete_existing_classification_node
Full name: azure-devops.azure_devops_wit_classification_nodes_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`structure_group`	string	yes	Structure group of the classification node, area or iteration.
`path`	string	yes	Path of the classification node.
`reclassify_id`	number	no	Id of the target classification node for reclassification.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_information_all_fields_project_id_name_parameter_is_optional Read

Returns information for all fields. The project ID/name parameter is optional. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_information_all_fields_project_id_name_parameter_is_optional
Full name: azure-devops.azure_devops_wit_fields_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`expand`	string	no	Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

create_new_field Read

Create a new field. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/fields (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.create_new_field
Full name: azure-devops.azure_devops_wit_fields_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	New field definition
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_information_specific_field Read

Gets information on a specific field. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_information_specific_field
Full name: azure-devops.azure_devops_wit_fields_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`field_name_or_ref_name`	string	yes	Field simple name or reference name
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_field Read

Update a field. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.update_field
Full name: azure-devops.azure_devops_wit_fields_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Payload contains desired value of the field's properties
`field_name_or_ref_name`	string	yes	Name/reference name of the field to be updated
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

deletes_field_undelete_filed_see_update_field_api Read

Deletes the field. To undelete a filed, see "Update Field" API. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.deletes_field_undelete_filed_see_update_field_api
Full name: azure-devops.azure_devops_wit_fields_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`field_name_or_ref_name`	string	yes	Field simple name or reference name
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

migrates_project_different_process_within_same_oob_type_example_you_can_only_migrate_project_from_agile_custom_agile_agile_custom_agile

Read

Migrates a project to a different process within the same OOB type. For example, you can only migrate a project from agile/custom-agile to agile/custom-agile. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/projectprocessmigration (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.migrates_project_different_process_within_same_oob_type_example_you_can_only_migrate_project_from_agile_custom_agile_agile_custom_agile
Full name: azure-devops.azure_devops_wit_project_process_migration_migrate_projects_process

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_root_queries_and_their_children Read

Gets the root queries and their children Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_root_queries_and_their_children
Full name: azure-devops.azure_devops_wit_queries_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`expand`	string	no	Include the query string (wiql), clauses, query result columns, and sort options in the results.
`depth`	number	no	In the folder of queries, return child queries and folders to this depth.
`include_deleted`	boolean	no	Include deleted queries and folders
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

retrieves_individual_query_and_its_children Read

Retrieves an individual query and its children Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.retrieves_individual_query_and_its_children
Full name: azure-devops.azure_devops_wit_queries_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`query`	string	yes	ID or path of the query.
`expand`	string	no	Include the query string (wiql), clauses, query result columns, and sort options in the results.
`depth`	number	no	In the folder of queries, return child queries and folders to this depth.
`include_deleted`	boolean	no	Include deleted queries and folders
`use_iso_date_format`	boolean	no	DateTime query clauses will be formatted using a ISO 8601 compliant format
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

creates_query_or_moves_query_learn_more_about_work_item_query_language_wiql_syntax_here_https_docs_microsoft_com_en_vsts_collaborate_wiql_syntax_toc_vsts_work_track_toc_json_bc_vsts_work_track_breadcrumb_toc_json_view_vsts

Read

Creates a query, or moves a query. Learn more about Work Item Query Language (WIQL) syntax [here](https://docs.microsoft.com/en-us/vsts/collaborate/wiql-syntax?toc=/vsts/work/track/toc.json&bc=/vsts/work/track/breadcrumb/toc.json&view=vsts). Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.creates_query_or_moves_query_learn_more_about_work_item_query_language_wiql_syntax_here_https_docs_microsoft_com_en_vsts_collaborate_wiql_syntax_toc_vsts_work_track_toc_json_bc_vsts_work_track_breadcrumb_toc_json_view_vsts
Full name: azure-devops.azure_devops_wit_queries_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The query to create.
`project`	string	yes	Project ID or project name
`query`	string	yes	The parent id or path under which the query is to be created.
`validate_wiql_only`	boolean	no	If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_query_or_folder_this_allows_you_update_rename_and_move_queries_and_folders Read

Update a query or a folder. This allows you to update, rename and move queries and folders. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.update_query_or_folder_this_allows_you_update_rename_and_move_queries_and_folders
Full name: azure-devops.azure_devops_wit_queries_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The query to update.
`project`	string	yes	Project ID or project name
`query`	string	yes	The ID or path for the query to update.
`undelete_descendants`	boolean	no	Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

delete_query_or_folder_this_deletes_any_permission_change_deleted_query_or_folder_and_any_its_descendants_if_it_is_folder_it_is_important_note_that_deleted_permission_changes_cannot_be_recovered_upon_undeleting_query_or_folder

Read

Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.delete_query_or_folder_this_deletes_any_permission_change_deleted_query_or_folder_and_any_its_descendants_if_it_is_folder_it_is_important_note_that_deleted_permission_changes_cannot_be_recovered_upon_undeleting_query_or_folder
Full name: azure-devops.azure_devops_wit_queries_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`query`	string	yes	ID or path of the query or folder to delete.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_list_queries_by_ids_maximum_1000 Read

Gets a list of queries by ids (Maximum 1000) Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/queriesbatch (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_list_queries_by_ids_maximum_1000
Full name: azure-devops.azure_devops_wit_queries_get_queries_batch

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_list_ids_and_urls_deleted_work_items_recycle_bin Read

Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/recyclebin (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_list_ids_and_urls_deleted_work_items_recycle_bin
Full name: azure-devops.azure_devops_wit_recyclebin_get_deleted_work_item_shallow_references

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_deleted_work_item_from_recycle_bin Read

Gets a deleted work item from Recycle Bin. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/recyclebin/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_deleted_work_item_from_recycle_bin
Full name: azure-devops.azure_devops_wit_recyclebin_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	ID of the work item to be returned
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

restores_deleted_work_item_from_recycle_bin Read

Restores the deleted work item from Recycle Bin. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/recyclebin/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.restores_deleted_work_item_from_recycle_bin
Full name: azure-devops.azure_devops_wit_recyclebin_restore_work_item

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Paylod with instructions to update the IsDeleted flag to false
`id`	number	yes	ID of the work item to be restored
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

destroys_specified_work_item_permanently_from_recycle_bin_this_action_can_not_be_undone Read

Destroys the specified work item permanently from the Recycle Bin. This action can not be undone. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/recyclebin/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.destroys_specified_work_item_permanently_from_recycle_bin_this_action_can_not_be_undone
Full name: azure-devops.azure_devops_wit_recyclebin_destroy_work_item

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	ID of the work item to be destroyed permanently
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_apis_wit_reporting_workitemrevisions_discussions Read

GET /{organization}/{project}/_apis/wit/reporting/workItemRevisions/discussions Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workItemRevisions/discussions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_wit_reporting_workitemrevisions_discussions
Full name: azure-devops.azure_devops_wit_work_item_revisions_discussions_read_reporting_discussions

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`continuation_token`	string	no	query parameter `continuationToken`.
`max_page_size`	number	no	query parameter `$maxPageSize`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_batch_work_item_links Read

Get a batch of work item links Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemlinks (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_batch_work_item_links
Full name: azure-devops.azure_devops_wit_reporting_work_item_links_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`link_types`	string	no	A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
`types`	string	no	A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
`continuation_token`	string	no	Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
`start_date_time`	string	no	Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_batch_work_item_revisions_with_option_including_deleted_items Read

Get a batch of work item revisions with the option of including deleted items Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_batch_work_item_revisions_with_option_including_deleted_items
Full name: azure-devops.azure_devops_wit_reporting_work_item_revisions_read_reporting_revisions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`fields`	string	no	A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
`types`	string	no	A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
`continuation_token`	string	no	Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
`start_date_time`	string	no	Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
`include_identity_ref`	boolean	no	Return an identity reference instead of a string value for identity fields.
`include_deleted`	boolean	no	Specify if the deleted item should be returned.
`include_tag_ref`	boolean	no	Specify if the tag objects should be returned for System.Tags field.
`include_latest_only`	boolean	no	Return only the latest revisions of work items, skipping all historical revisions
`expand`	string	no	Return all the fields in work item revisions, including long text fields which are not returned by default
`include_discussion_changes_only`	boolean	no	Return only the those revisions of work items, where only history field was changed
`max_page_size`	number	no	The maximum number of results to return in this batch
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_batch_work_item_revisions_this_request_may_be_used_if_your_list_fields_is_large_enough_that_it_may_run_url_over_length_limit

Read

Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_batch_work_item_revisions_this_request_may_be_used_if_your_list_fields_is_large_enough_that_it_may_run_url_over_length_limit
Full name: azure-devops.azure_devops_wit_reporting_work_item_revisions_read_reporting_revisions_post

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	An object that contains request settings: field filter, type filter, identity format
`project`	string	yes	Project ID or project name
`continuation_token`	string	no	Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
`start_date_time`	string	no	Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

restful_method_send_mail_selected_queried_work_items Write

RESTful method to send mail for selected/queried work items. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/sendmail (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.restful_method_send_mail_selected_queried_work_items
Full name: azure-devops.azure_devops_wit_send_mail_send_mail

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_tags_project Read

Get all the tags for the project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/tags (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_all_tags_project
Full name: azure-devops.azure_devops_wit_tags_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_tag_project Read

Get the tag for the project. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_tag_project
Full name: azure-devops.azure_devops_wit_tags_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`tag_id_or_name`	string	yes	Tag ID or tag name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_tag_project Read

Update the tag for the project. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.update_tag_project
Full name: azure-devops.azure_devops_wit_tags_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`tag_id_or_name`	string	yes	Tag ID or tag name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_tag_project_please_note_that_deleted_tag_will_be_removed_from_all_work_items_well_pull_requests Read

Delete the tag for the project. Please note, that the deleted tag will be removed from all Work Items as well as Pull Requests. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.delete_tag_project_please_note_that_deleted_tag_will_be_removed_from_all_work_items_well_pull_requests
Full name: azure-devops.azure_devops_wit_tags_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`tag_id_or_name`	string	yes	Tag ID or tag name.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_temporary_query_learn_more_about_work_item_query_language_wiql_syntax_here_https_docs_microsoft_com_en_vsts_collaborate_wiql_syntax_toc_vsts_work_track_toc_json_bc_vsts_work_track_breadcrumb_toc_json_view_vsts

Read

Creates a temporary query Learn more about Work Item Query Language (WIQL) syntax [here](https://docs.microsoft.com/en-us/vsts/collaborate/wiql-syntax?toc=/vsts/work/track/toc.json&bc=/vsts/work/track/breadcrumb/toc.json&view=vsts). Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/tempqueries (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.creates_temporary_query_learn_more_about_work_item_query_language_wiql_syntax_here_https_docs_microsoft_com_en_vsts_collaborate_wiql_syntax_toc_vsts_work_track_toc_json_bc_vsts_work_track_breadcrumb_toc_json_view_vsts
Full name: azure-devops.azure_devops_wit_temp_queries_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The temporary query to create
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_fully_hydrated_work_item_revisions_paged Read

Returns the list of fully hydrated work item revisions, paged. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/revisions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_list_fully_hydrated_work_item_revisions_paged
Full name: azure-devops.azure_devops_wit_revisions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	path parameter `id`.
`project`	string	yes	Project ID or project name
`top`	number	no	query parameter `$top`.
`skip`	number	no	query parameter `$skip`.
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_fully_hydrated_work_item_requested_revision Read

Returns a fully hydrated work item for the requested revision Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/revisions/{revisionNumber} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_fully_hydrated_work_item_requested_revision
Full name: azure-devops.azure_devops_wit_revisions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	path parameter `id`.
`revision_number`	number	yes	path parameter `revisionNumber`.
`project`	string	yes	Project ID or project name
`expand`	string	no	query parameter `$expand`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_deltas_between_work_item_revisions Read

Returns the deltas between work item revisions Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_deltas_between_work_item_revisions
Full name: azure-devops.azure_devops_wit_updates_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	path parameter `id`.
`project`	string	yes	Project ID or project name
`top`	number	no	query parameter `$top`.
`skip`	number	no	query parameter `$skip`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_single_update_work_item Read

Returns a single update for a work item Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates/{updateNumber} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_single_update_work_item
Full name: azure-devops.azure_devops_wit_updates_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	path parameter `id`.
`update_number`	number	yes	path parameter `updateNumber`.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_list_work_item_comments_by_ids Read

Returns a list of work item comments by ids. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_list_work_item_comments_by_ids
Full name: azure-devops.azure_devops_wit_comments_get_comments_batch

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	Id of a work item to get comments for.
`ids`	string	no	Comma-separated list of comment ids to return.
`include_deleted`	boolean	no	Specify if the deleted comments should be retrieved.
`expand`	string	no	Specifies the additional data retrieval options for work item comments.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

add_comment_work_item Write

Add a comment on a work item. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.add_comment_work_item
Full name: azure-devops.azure_devops_wit_comments_add_comment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Comment create request.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	Id of a work item.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

returns_work_item_comment Read

Returns a work item comment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_work_item_comment
Full name: azure-devops.azure_devops_wit_comments_get_comment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	Id of a work item to get the comment.
`comment_id`	number	yes	Id of the comment to return.
`include_deleted`	boolean	no	Specify if the deleted comment should be retrieved.
`expand`	string	no	Specifies the additional data retrieval options for work item comments.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

update_comment_work_item Write

Update a comment on a work item. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.update_comment_work_item
Full name: azure-devops.azure_devops_wit_comments_update_comment

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Comment update request.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	Id of a work item.
`comment_id`	number	yes	path parameter `commentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

delete_comment_work_item Read

Delete a comment on a work item. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.delete_comment_work_item
Full name: azure-devops.azure_devops_wit_comments_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	Id of a work item.
`comment_id`	number	yes	path parameter `commentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.4`.

gets_reactions_comment Read

Gets reactions of a comment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/reactions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_reactions_comment
Full name: azure-devops.azure_devops_wit_comments_reactions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	WorkItem ID
`comment_id`	number	yes	Comment ID
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

adds_new_reaction_comment Read

Adds a new reaction to a comment. Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/reactions/{reactionType} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.adds_new_reaction_comment
Full name: azure-devops.azure_devops_wit_comments_reactions_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	WorkItem ID
`comment_id`	number	yes	Comment ID
`reaction_type`	string	yes	Type of the reaction
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.
`body`	object	no	Request body matching the official Azure DevOps Swagger schema.

deletes_existing_reaction_comment Read

Deletes an existing reaction on a comment. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/reactions/{reactionType} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.deletes_existing_reaction_comment
Full name: azure-devops.azure_devops_wit_comments_reactions_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	WorkItem ID
`comment_id`	number	yes	Comment ID
`reaction_type`	string	yes	Type of the reaction
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_users_who_reacted_comment Read

Get users who reacted on the comment. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/reactions/{reactionType}/users (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_users_who_reacted_comment
Full name: azure-devops.azure_devops_wit_comment_reactions_engaged_users_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	WorkItem ID.
`comment_id`	number	yes	Comment ID.
`reaction_type`	string	yes	Type of the reaction.
`top`	number	no	query parameter `$top`.
`skip`	number	no	query parameter `$skip`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_wit_workitems_workitemid_comments_commentid_versions Read

GET /{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/versions Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/versions (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_wit_workitems_workitemid_comments_commentid_versions
Full name: azure-devops.azure_devops_wit_comments_versions_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	path parameter `workItemId`.
`comment_id`	number	yes	path parameter `commentId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_apis_wit_workitems_workitemid_comments_commentid_versions_version Read

GET /{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/versions/{version} Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}/versions/{version} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_organization_project_apis_wit_workitems_workitemid_comments_commentid_versions_version
Full name: azure-devops.azure_devops_wit_comments_versions_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`work_item_id`	number	yes	path parameter `workItemId`.
`comment_id`	number	yes	path parameter `commentId`.
`version`	number	yes	path parameter `version`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_work_items_maximum_200 Read

Returns a list of work items (Maximum 200) Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_list_work_items_maximum_200
Full name: azure-devops.azure_devops_wit_work_items_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`ids`	string	no	The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
`project`	string	yes	Project ID or project name
`fields`	string	no	Comma-separated list of requested fields
`as_of`	string	no	AsOf UTC date time string
`expand`	string	no	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
`error_policy`	string	no	The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_single_work_item_from_template Read

Returns a single work item from a template. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_single_work_item_from_template
Full name: azure-devops.azure_devops_wit_work_items_get_work_item_template

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type`	string	yes	The work item type name
`fields`	string	no	Comma-separated list of requested fields
`as_of`	string	no	AsOf UTC date time string
`expand`	string	no	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

creates_single_work_item Read

Creates a single work item. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.creates_single_work_item
Full name: azure-devops.azure_devops_wit_work_items_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The JSON Patch document representing the work item
`project`	string	yes	Project ID or project name
`type`	string	yes	The work item type of the work item to create
`validate_only`	boolean	no	Indicate if you only want to validate the changes without saving the work item
`bypass_rules`	boolean	no	Do not enforce the work item type rules on this update
`suppress_notifications`	boolean	no	Do not fire any notifications for this change
`expand`	string	no	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_single_work_item Read

Returns a single work item. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_single_work_item
Full name: azure-devops.azure_devops_wit_work_items_get_work_item

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	The work item id
`project`	string	yes	Project ID or project name
`fields`	string	no	Comma-separated list of requested fields
`as_of`	string	no	AsOf UTC date time string
`expand`	string	no	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

updates_single_work_item Read

Updates a single work item. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.updates_single_work_item
Full name: azure-devops.azure_devops_wit_work_items_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The JSON Patch document representing the update
`id`	number	yes	The id of the work item to update
`project`	string	yes	Project ID or project name
`validate_only`	boolean	no	Indicate if you only want to validate the changes without saving the work item
`bypass_rules`	boolean	no	Do not enforce the work item type rules on this update
`suppress_notifications`	boolean	no	Do not fire any notifications for this change
`expand`	string	no	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

deletes_specified_work_item_and_sends_it_recycle_bin_so_that_it_can_be_restored_back_if_required_optionally_if_destroy_parameter_has_been_set_true_it_destroys_work_item_permanently_warning_if_destroy_parameter_is_set_true_work_items_deleted_by_this_command_will_not_go_recycle_bin_and_there_is_no_way_restore_recover_them_after_deletion_it_is_recommended_not_use_this_parameter_if_you_do_please_use_this_parameter_with_extreme_caution

Read

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution. Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.deletes_specified_work_item_and_sends_it_recycle_bin_so_that_it_can_be_restored_back_if_required_optionally_if_destroy_parameter_has_been_set_true_it_destroys_work_item_permanently_warning_if_destroy_parameter_is_set_true_work_items_deleted_by_this_command_will_not_go_recycle_bin_and_there_is_no_way_restore_recover_them_after_deletion_it_is_recommended_not_use_this_parameter_if_you_do_please_use_this_parameter_with_extreme_caution
Full name: azure-devops.azure_devops_wit_work_items_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	number	yes	ID of the work item to be deleted
`project`	string	yes	Project ID or project name
`destroy`	boolean	no	Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

gets_work_items_list_work_item_ids_maximum_200 Read

Gets work items for a list of work item ids (Maximum 200) Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsbatch (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_work_items_list_work_item_ids_maximum_200
Full name: azure-devops.azure_devops_wit_work_items_get_work_items_batch

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_specified_work_items_and_sends_them_recycle_bin_so_that_it_can_be_restored_back_if_required_optionally_if_destroy_parameter_has_been_set_true_it_destroys_work_item_permanently_warning_if_destroy_parameter_is_set_true_work_items_deleted_by_this_command_will_not_go_recycle_bin_and_there_is_no_way_restore_recover_them_after_deletion

Write

Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsdelete (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.deletes_specified_work_items_and_sends_them_recycle_bin_so_that_it_can_be_restored_back_if_required_optionally_if_destroy_parameter_has_been_set_true_it_destroys_work_item_permanently_warning_if_destroy_parameter_is_set_true_work_items_deleted_by_this_command_will_not_go_recycle_bin_and_there_is_no_way_restore_recover_them_after_deletion
Full name: azure-devops.azure_devops_wit_work_items_delete_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_all_work_item_type_categories Read

Get all work item type categories. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypecategories (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_all_work_item_type_categories
Full name: azure-devops.azure_devops_wit_work_item_type_categories_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_specific_work_item_type_category_by_name Read

Get specific work item type category by name. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypecategories/{category} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_specific_work_item_type_category_by_name
Full name: azure-devops.azure_devops_wit_work_item_type_categories_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`category`	string	yes	The category name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_list_work_item_types Read

Returns the list of work item types Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_list_work_item_types
Full name: azure-devops.azure_devops_wit_work_item_types_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

returns_work_item_type_definition Read

Returns a work item type definition. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_work_item_type_definition
Full name: azure-devops.azure_devops_wit_work_item_types_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type`	string	yes	Work item type name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_list_fields_work_item_type_with_detailed_references Read

Get a list of fields for a work item type with detailed references. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_list_fields_work_item_type_with_detailed_references
Full name: azure-devops.azure_devops_wit_work_item_types_field_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type`	string	yes	Work item type.
`expand`	string	no	Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_field_work_item_type_with_detailed_references Read

Get a field for a work item type with detailed references. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.get_field_work_item_type_with_detailed_references
Full name: azure-devops.azure_devops_wit_work_item_types_field_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type`	string	yes	Work item type.
`field`	string	yes	path parameter `field`.
`expand`	string	no	Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

returns_state_names_and_colors_work_item_type Read

Returns the state names and colors for a work item type. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/states (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.returns_state_names_and_colors_work_item_type
Full name: azure-devops.azure_devops_wit_work_item_type_states_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`type`	string	yes	The state name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_template Read

Gets template Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_template
Full name: azure-devops.azure_devops_wit_templates_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`workitemtypename`	string	no	Optional, When specified returns templates for given Work item type.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

creates_template Read

Creates a template Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.creates_template
Full name: azure-devops.azure_devops_wit_templates_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Template contents
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_template_with_specified_id Read

Gets the template with specified id Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates/{templateId} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_template_with_specified_id
Full name: azure-devops.azure_devops_wit_templates_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`template_id`	string	yes	Template Id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

replace_template_contents Read

Replace template contents Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates/{templateId} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.replace_template_contents
Full name: azure-devops.azure_devops_wit_templates_replace_template

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Template contents to replace with
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`template_id`	string	yes	Template id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

deletes_template_with_given_id Read

Deletes the template with given id Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates/{templateId} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.deletes_template_with_given_id
Full name: azure-devops.azure_devops_wit_templates_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`template_id`	string	yes	Template id
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_results_query_given_its_wiql Read

Gets the results of the query given its WIQL. Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_results_query_given_its_wiql
Full name: azure-devops.azure_devops_wit_wiql_query_by_wiql

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	The query containing the WIQL.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`time_precision`	boolean	no	Whether or not to use time precision.
`top`	number	no	The max number of results to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

gets_results_query_given_query_id Read

Gets the results of the query given the query ID. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id} (spec: wit/7.2/workItemTracking.json).

Lua path: app.integrations.azure_devops.gets_results_query_given_query_id
Full name: azure-devops.azure_devops_wit_wiql_query_by_id

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`id`	string	yes	The query ID.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`time_precision`	boolean	no	Whether or not to use time precision.
`top`	number	no	The max number of results to return.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_available_board_columns_project Read

Get available board columns in a project Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/boardcolumns (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_available_board_columns_project
Full name: azure-devops.azure_devops_work_boardcolumns_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_available_board_rows_project Read

Get available board rows in a project Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/boardrows (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_available_board_rows_project
Full name: azure-devops.azure_devops_work_boardrows_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_iteration_capacity_all_teams_iteration Read

Get an iteration's capacity for all teams in iteration Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/iterations/{iterationId}/iterationcapacities (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_iteration_capacity_all_teams_iteration
Full name: azure-devops.azure_devops_work_iterationcapacities_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_all_plans_configured_given_team Read

Get the information for all the plans configured for the given team Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/plans (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_information_all_plans_configured_given_team
Full name: azure-devops.azure_devops_work_plans_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_new_plan_team Read

Add a new plan for the team Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/_apis/work/plans (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.add_new_plan_team
Full name: azure-devops.azure_devops_work_plans_create

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Plan definition
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_information_specified_plan Read

Get the information for the specified plan Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_information_specified_plan
Full name: azure-devops.azure_devops_work_plans_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	Identifier of the plan
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_information_specified_plan Read

Update the information for the specified plan Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_information_specified_plan
Full name: azure-devops.azure_devops_work_plans_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Plan definition to be updated
`project`	string	yes	Project ID or project name
`id`	string	yes	Identifier of the plan
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_specified_plan Read

Delete the specified plan Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.delete_specified_plan
Full name: azure-devops.azure_devops_work_plans_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	Identifier of the plan
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_delivery_view_data Read

Get Delivery View Data Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}/deliverytimeline (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_delivery_view_data
Full name: azure-devops.azure_devops_work_deliverytimeline_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	Identifier for delivery view
`revision`	number	no	Revision of the plan for which you want data. If the current plan is a different revision you will get an ViewRevisionMismatchException exception. If you do not supply a revision you will get data for the latest revision.
`start_date`	string	no	The start date of timeline
`end_date`	string	no	The end date of timeline
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieves_set_known_queries Read

Retrieves the set of known queries Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/predefinedqueries (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.retrieves_set_known_queries
Full name: azure-devops.azure_devops_work_predefined_queries_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

retrieves_specified_predefined_query_including_query_results Read

Retrieves the specified predefined query including the query results Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/predefinedqueries/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.retrieves_specified_predefined_query_including_query_results
Full name: azure-devops.azure_devops_work_predefined_queries_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	Id of the query to run
`top`	number	no	The maximum number of items to return
`include_completed`	boolean	no	Whether or not to retrieve the 'completed' work items (work items in the 'completed' meta state)
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_process_configuration Read

Get process configuration Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/_apis/work/processconfiguration (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_process_configuration
Full name: azure-devops.azure_devops_work_processconfiguration_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

gets_backlog_configuration_team Read

Gets backlog configuration for a team Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogconfiguration (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.gets_backlog_configuration_team
Full name: azure-devops.azure_devops_work_backlogconfiguration_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

list_all_backlog_levels Read

List all backlog levels Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogs (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.list_all_backlog_levels
Full name: azure-devops.azure_devops_work_backlogs_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_list_work_items_within_backlog_level Read

Get a list of work items within a backlog level Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogs/{backlogId}/workItems (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_list_work_items_within_backlog_level
Full name: azure-devops.azure_devops_work_backlogs_get_backlog_level_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`backlog_id`	string	yes	path parameter `backlogId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_backlog_level Read

Get a backlog level Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogs/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_backlog_level
Full name: azure-devops.azure_devops_work_backlogs_get_backlog

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`id`	string	yes	The id of the backlog level
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_boards Read

Get boards Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_boards
Full name: azure-devops.azure_devops_work_boards_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

returns_list_parent_field_filter_model_given_list_workitem_ids Read

Returns the list of parent field filter model for the given list of workitem ids Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/boardparents (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.returns_list_parent_field_filter_model_given_list_workitem_ids
Full name: azure-devops.azure_devops_work_boardparents_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`child_backlog_context_category_ref_name`	string	no	query parameter `childBacklogContextCategoryRefName`.
`workitem_ids`	string	no	query parameter `workitemIds`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_board_user_settings_board_id Read

Get board user settings for a board id Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/boardusersettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board_user_settings_board_id
Full name: azure-devops.azure_devops_work_boardusersettings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	Board ID or Name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_board_user_settings_board_id_we_don_t_want_stakeholders_update_board_settings_currently_just_autorefresh_backlogmanagement_feature_check_validates_this

Read

Update board user settings for the board id We don't want stakeholders to update board settings (currently just autorefresh). The BacklogManagement feature check validates this. Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/boardusersettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_board_user_settings_board_id_we_don_t_want_stakeholders_update_board_settings_currently_just_autorefresh_backlogmanagement_feature_check_validates_this
Full name: azure-devops.azure_devops_work_boardusersettings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`board`	string	yes	path parameter `board`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_board_card_rule_settings_board_id_or_board_by_name Read

Get board card Rule settings for the board id or board by name Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/cardrulesettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board_card_rule_settings_board_id_or_board_by_name
Full name: azure-devops.azure_devops_work_cardrulesettings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	path parameter `board`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_board_card_rule_settings_board_id_or_board_by_name Write

Update board card Rule settings for the board id or board by name Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/cardrulesettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_board_card_rule_settings_board_id_or_board_by_name
Full name: azure-devops.azure_devops_work_cardrulesettings_update_board_card_rule_settings

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`board`	string	yes	path parameter `board`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_board_card_settings_board_id_or_board_by_name Read

Get board card settings for the board id or board by name Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/cardsettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board_card_settings_board_id_or_board_by_name
Full name: azure-devops.azure_devops_work_cardsettings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	path parameter `board`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_board_card_settings_board_id_or_board_by_name Write

Update board card settings for the board id or board by name Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/cardsettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_board_card_settings_board_id_or_board_by_name
Full name: azure-devops.azure_devops_work_cardsettings_update_board_card_settings

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`board`	string	yes	path parameter `board`.
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_board_chart_image Read

Get a board chart image. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/chartimages/{name} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board_chart_image
Full name: azure-devops.azure_devops_work_chartimages_get_board_chart_image

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`board`	string	yes	Identifier for board, either board's backlog level name (e.g. "Issues") or Id.
`name`	string	yes	The chart name. e.g. CumulativeFlow.
`width`	number	no	The width of the chart in pixels. Must be greater than 0.
`height`	number	no	The height of the chart in pixels. Must be greater than 0.
`show_details`	boolean	no	Whether or not the chart should include detailed information (e.g. axis labels, titles, trend lines, etc.).
`title`	string	no	The title of the chart. Can only be dislayed if ShowLabels is true.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_board_charts Read

Get board charts Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/charts (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board_charts
Full name: azure-devops.azure_devops_work_charts_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	Identifier for board, either board's backlog level name (Eg:"Stories") or Id
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_board_chart Read

Get a board chart Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/charts/{name} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board_chart
Full name: azure-devops.azure_devops_work_charts_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	Identifier for board, either board's backlog level name (Eg:"Stories") or Id
`name`	string	yes	The chart name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_board_chart Read

Update a board chart Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/charts/{name} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_board_chart
Full name: azure-devops.azure_devops_work_charts_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`board`	string	yes	Identifier for board, either board's backlog level name (Eg:"Stories") or Id
`name`	string	yes	The chart name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_columns_board Read

Get columns on a board Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/columns (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_columns_board
Full name: azure-devops.azure_devops_work_columns_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	Name or ID of the specific board
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_columns_board Read

Update columns on a board Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/columns (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_columns_board
Full name: azure-devops.azure_devops_work_columns_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of board columns to update
`project`	string	yes	Project ID or project name
`board`	string	yes	Name or ID of the specific board
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_rows_board Read

Get rows on a board Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/rows (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_rows_board
Full name: azure-devops.azure_devops_work_rows_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`board`	string	yes	Name or ID of the specific board
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_rows_board Read

Update rows on a board Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/rows (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_rows_board
Full name: azure-devops.azure_devops_work_rows_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	List of board rows to update
`project`	string	yes	Project ID or project name
`board`	string	yes	Name or ID of the specific board
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_board Read

Get board Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_board
Full name: azure-devops.azure_devops_work_boards_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	identifier for board, either board's backlog level name (Eg:"Stories") or Id
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_board_options Read

Update board options Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_board_options
Full name: azure-devops.azure_devops_work_boards_set_board_options

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	options to updated
`project`	string	yes	Project ID or project name
`id`	string	yes	identifier for board, either category plural name (Eg:"Stories") or guid
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_iterations_chart_image Read

Get an iterations chart image. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/iterations/chartimages/{name} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_iterations_chart_image
Full name: azure-devops.azure_devops_work_chartimages_get_iterations_chart_image

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`name`	string	yes	The chart name. e.g. Velocity.
`iterations_number`	number	no	Number of iterations the chart is for.
`width`	number	no	The width of the chart in pixels. Must be greater than 0.
`height`	number	no	The height of the chart in pixels. Must be greater than 0.
`show_details`	boolean	no	Whether or not the chart should include detailed information (e.g. axis labels, titles, trend lines, etc.)
`title`	string	no	The title of the chart. Can only be dislayed if ShowLabels is true.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_iteration_chart_image Read

Get an iteration chart image. Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/iterations/{iterationId}/chartimages/{name} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_iteration_chart_image
Full name: azure-devops.azure_devops_work_chartimages_get_iteration_chart_image

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`iteration_id`	string	yes	ID of the iteration.
`name`	string	yes	The chart name. e.g. Burndown.
`width`	number	no	The width of the chart in pixels. Must be greater than 0.
`height`	number	no	The height of the chart in pixels. Must be greater than 0.
`show_details`	boolean	no	Whether or not the chart should include detailed information (e.g. axis labels, titles, trend lines, etc.)
`title`	string	no	The title of the chart. Can only be dislayed if ShowLabels is true.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

reorder_sprint_backlog_taskboard_work_items Read

Reorder Sprint Backlog/Taskboard Work Items Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/iterations/{iterationId}/workitemsorder (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.reorder_sprint_backlog_taskboard_work_items
Full name: azure-devops.azure_devops_work_workitemsorder_reorder_iteration_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`iteration_id`	string	yes	The id of the iteration
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_taskboard_card_rule_settings Write

Update taskboard card Rule settings Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboard/cardrulesettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_taskboard_card_rule_settings
Full name: azure-devops.azure_devops_work_cardrulesettings_update_taskboard_card_rule_settings

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

update_taskboard_card_settings Write

Update taskboard card settings Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboard/cardsettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_taskboard_card_settings
Full name: azure-devops.azure_devops_work_cardsettings_update_taskboard_card_settings

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.2`.

get_organization_project_team_apis_work_taskboardcolumns Read

GET /{organization}/{project}/{team}/_apis/work/taskboardcolumns Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboardcolumns (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_organization_project_team_apis_work_taskboardcolumns
Full name: azure-devops.azure_devops_work_taskboard_columns_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

put_organization_project_team_apis_work_taskboardcolumns Read

PUT /{organization}/{project}/{team}/_apis/work/taskboardcolumns Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboardcolumns (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.put_organization_project_team_apis_work_taskboardcolumns
Full name: azure-devops.azure_devops_work_taskboard_columns_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_organization_project_team_apis_work_taskboardworkitems_iterationid Read

GET /{organization}/{project}/{team}/_apis/work/taskboardworkitems/{iterationId} Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboardworkitems/{iterationId} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_organization_project_team_apis_work_taskboardworkitems_iterationid
Full name: azure-devops.azure_devops_work_taskboard_work_items_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`iteration_id`	string	yes	path parameter `iterationId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

patch_organization_project_team_apis_work_taskboardworkitems_iterationid_workitemid Read

PATCH /{organization}/{project}/{team}/_apis/work/taskboardworkitems/{iterationId}/{workItemId} Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboardworkitems/{iterationId}/{workItemId} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.patch_organization_project_team_apis_work_taskboardworkitems_iterationid_workitemid
Full name: azure-devops.azure_devops_work_taskboard_work_items_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`iteration_id`	string	yes	path parameter `iterationId`.
`work_item_id`	number	yes	path parameter `workItemId`.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_team_settings Read

Get a team's settings Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_team_settings
Full name: azure-devops.azure_devops_work_teamsettings_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_team_settings Read

Update a team's settings Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_team_settings
Full name: azure-devops.azure_devops_work_teamsettings_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	TeamSettings changes
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_team_iterations_using_timeframe_filter Read

Get a team's iterations using timeframe filter Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_team_iterations_using_timeframe_filter
Full name: azure-devops.azure_devops_work_iterations_list

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`timeframe`	string	no	A filter for which iterations are returned based on relative time. Only Current is supported currently.
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

add_iteration_team Read

Add an iteration to the team Official Azure DevOps REST API 7.2 endpoint: POST https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.add_iteration_team
Full name: azure-devops.azure_devops_work_iterations_post_team_iteration

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Iteration to add
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_team_iteration_by_iterationid Read

Get team's iteration by iterationId Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_team_iteration_by_iterationid
Full name: azure-devops.azure_devops_work_iterations_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

delete_team_iteration_by_iterationid Read

Delete a team's iteration by iterationId Official Azure DevOps REST API 7.2 endpoint: DELETE https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{id} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.delete_team_iteration_by_iterationid
Full name: azure-devops.azure_devops_work_iterations_delete

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_team_capacity_including_total_capacity_and_days_off Read

Get a team's capacity including total capacity and days off Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_team_capacity_including_total_capacity_and_days_off
Full name: azure-devops.azure_devops_work_capacities_get_capacities_with_identity_ref_and_totals

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

replace_team_capacity Read

Replace a team's capacity Official Azure DevOps REST API 7.2 endpoint: PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.replace_team_capacity
Full name: azure-devops.azure_devops_work_capacities_replace_capacities_with_identity_ref

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Team capacity to replace
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_team_member_capacity Read

Get a team member's capacity Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities/{teamMemberId} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_team_member_capacity
Full name: azure-devops.azure_devops_work_capacities_get_capacity_with_identity_ref

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team_member_id`	string	yes	ID of the team member
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

update_team_member_capacity Read

Update a team member's capacity Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities/{teamMemberId} (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_team_member_capacity
Full name: azure-devops.azure_devops_work_capacities_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Updated capacity
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team_member_id`	string	yes	ID of the team member
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.3`.

get_team_days_off_iteration Read

Get team's days off for an iteration Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/teamdaysoff (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_team_days_off_iteration
Full name: azure-devops.azure_devops_work_teamdaysoff_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

set_team_days_off_iteration Read

Set a team's days off for an iteration Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/teamdaysoff (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.set_team_days_off_iteration
Full name: azure-devops.azure_devops_work_teamdaysoff_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Team's days off patch containing a list of start and end dates
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_work_items_iteration Read

Get work items for iteration Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/workitems (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_work_items_iteration
Full name: azure-devops.azure_devops_work_iterations_get_iteration_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`iteration_id`	string	yes	ID of the iteration
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

get_collection_team_field_values Read

Get a collection of team field values Official Azure DevOps REST API 7.2 endpoint: GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/teamfieldvalues (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.get_collection_team_field_values
Full name: azure-devops.azure_devops_work_teamfieldvalues_get

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

update_team_field_values Read

Update team field values Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/teamfieldvalues (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.update_team_field_values
Full name: azure-devops.azure_devops_work_teamfieldvalues_update

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.

reorder_product_backlog_boards_work_items Read

Reorder Product Backlog/Boards Work Items Official Azure DevOps REST API 7.2 endpoint: PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/workitemsorder (spec: work/7.2/work.json).

Lua path: app.integrations.azure_devops.reorder_product_backlog_boards_work_items
Full name: azure-devops.azure_devops_work_workitemsorder_reorder_backlog_work_items

Parameter	Type	Required	Description
`organization`	string	yes	The name of the Azure DevOps organization.
`body`	object	yes	Request body matching the official Azure DevOps Swagger schema.
`project`	string	yes	Project ID or project name
`team`	string	yes	Team ID or team name
`api_version`	string	no	Azure DevOps API version. Defaults to `7.2-preview.1`.