AzureDevOps (Beta)
AzureDevOps Pack.#
This Integration is part of theSupported versions
Supported Cortex XSOAR versions: 6.0.0 and later.
beta
#
Azure DevOpsManage Git repositories in Azure DevOps Services. Integration capabilities include retrieving, creating, and updating pull requests. Run pipelines and retrieve git information. ** Note: This is a beta Integration, which lets you implement and test pre-release software. Since the integration is beta, it might contain bugs. Updates to the integration during the beta phase might include non-backward compatible features. We appreciate your feedback on the quality and usability of the integration to help us identify issues, fix them, and continually improve. This integration was integrated and tested with version 6.1 of AzureDevOps
#
Configure AzureDevOps (Beta) on Cortex XSOARNavigate to Settings > Integrations > Servers & Services.
Search for AzureDevOps (Beta).
Click Add instance to create and configure a new integration instance.
Parameter Description Required Client ID App Registration Client ID True Organization Organizaion name True Maximum incidents for one fetch. Default is 50. Maximum is 200. False Pull-request project name The name of the project which the pull requests belongs to. This argument is mandatory for Fetch functionality. False Pull-request repository name The name of the repository pull request's target branch. This argument is mandatory for Fetch functionality. False Incident type False Fetch incidents False First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days) False Outgoing mirroring False Use system proxy settings False Trust any certificate (not secure) False Click Test to validate the URLs, token, and connection.
#
CommandsYou can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
#
azure-devops-auth-testTests the connectivity to Azure.
#
Base Commandazure-devops-auth-test
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command Example!azure-devops-auth-test
#
Human Readable OutputSuccess!
#
azure-devops-auth-startRun this command to start the authorization process and follow the instructions in the command results.
#
Base Commandazure-devops-auth-start
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command Example!azure-devops-auth-start
#
Human Readable Output#
Authorization instructions
- To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code *XXXX** to authenticate.
- Run the !azure-devops-auth-complete command in the War Room.
#
azure-devops-auth-completeRun this command to complete the authorization process. Should be used after running the azure-devops-auth-start command.
#
Base Commandazure-devops-auth-complete
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command Example!azure-devops-auth-complete
#
Human Readable OutputAuthorization completed successfully.
#
azure-devops-auth-resetRun this command if you need to rerun the authentication process for some reason.
#
Base Commandazure-devops-auth-reset
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command Example!azure-devops-auth-reset
#
Human Readable OutputAuthorization was reset successfully. Run !azure-devops-auth-start to start the authentication process.
#
get-mapping-fieldsGet mapping fields from remote incident. Please note that this method will not update the current incident. It's here for debugging purposes.
#
Base Commandget-mapping-fields
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command Example
#
Human Readable Output#
azure-devops-pipeline-runRun a pipeline. A DevOps pipeline is a set of automated processes and tools that allows both developers and operations professionals to work cohesively to build and deploy code to a production environment.
#
Base Commandazure-devops-pipeline-run
#
InputArgument Name | Description | Required |
---|---|---|
project | The name of the project. | Required |
pipeline_id | The ID of the pipeline. | Required |
branch_name | The name of the repository branch which runs the pipeline. | Required |
polling | Use Cortex XSOAR built-in polling to retrieve the result when it's ready. Possible values are: True, False. Default is False. | Optional |
interval | Indicates how long to wait between command execution (in seconds) when 'polling' argument is true. Minimum value is 10 seconds. Default is 30. | Optional |
timeout | Indicates the time in seconds until the polling sequence timeouts. Default is 60. | Optional |
run_id | The ID of the pipeline run to retrieve when polling argument is 'True'. Intended for use by the Polling process and does not need to be provided by the user. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PipelineRun.project | String | The name of the project. |
AzureDevOps.PipelineRun.pipeline.id | Number | The ID of the pipeline. |
AzureDevOps.PipelineRun.pipeline.name | String | The pipeline repository name. |
AzureDevOps.PipelineRun.state | String | The run state. |
AzureDevOps.PipelineRun.createdDate | Date | The run creation date, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PipelineRun.run_id | Number | The ID of the run. |
AzureDevOps.PipelineRun.name | String | The name of the run. |
AzureDevOps.PipelineRun.result | String | The result of the pipeline running. If the run is in progress, the default value is 'unknown'. |
#
Command Example!azure-devops-pipeline-run project="xsoar" pipeline_id="1" branch_name="main"
#
Context Example#
Human Readable Output#
Pipeline Run Information:
Pipeline Id Run State Creation Date Run Id Result 1 inProgress 2021-11-30T08:57:03.110121+00:00 1154 unknown
#
azure-devops-user-addAdd a user, assign the user a license and extensions, and make the user a member of a project group in an account.
#
Base Commandazure-devops-user-add
#
InputArgument Name | Description | Required |
---|---|---|
user_email | The email address of the user to add to the organization. | Required |
account_license_type | The type of account license. Possible values: "express", "stakeholder", "advanced", "earlyAdopter", and "professional". More information can be found here: https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user-entitlements/add?view=azure-devops-rest-6.1#accountlicensetype. | Required |
group_type | The project group type. Possible values: "projectReader", "projectContributor", "projectAdministrator", and "projectStakeholder". More information can be found here: https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user-entitlements/add?view=azure-devops-rest-6.1#grouptype. | Required |
project_id | The ID of the project. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.User.id | String | The ID of the user. |
#
Command Example!azure-devops-user-add user_email="user1@xsoar.com" account_license_type="express" group_type="projectContributor" project_id="xsoar-project"
#
Context Example#
Human Readable Output#
User Information:
Id Account License Type Last Accessed Date XXXX express 0001-01-01T00:00:00Z
#
azure-devops-user-removeRemove the user from all project memberships.
#
Base Commandazure-devops-user-remove
#
InputArgument Name | Description | Required |
---|---|---|
user_id | The ID of the user to be removed from the organization. A user ID can be obtained by running the 'azure-devops-user-list' command. | Required |
#
Context OutputThere is no context output for this command.
#
Command Example!azure-devops-user-remove user_id="XXXX"
#
Human Readable OutputUser XXXX was successfully removed from the organization.
#
azure-devops-pull-request-createCreate a new pull request.
#
Base Commandazure-devops-pull-request-create
#
InputArgument Name | Description | Required |
---|---|---|
project | The name or ID of the project. | Required |
repository_id | The repository ID of the pull request's target branch. A repository ID can be obtained by running the 'azure-devops-repository-list' command. | Required |
source_branch | The name of the source branch of the pull request. | Required |
target_branch | The name of the target branch of the pull request. | Required |
title | The title of the pull request. | Required |
description | The description of the pull request. | Required |
reviewers_ids | Comma-separated list of the pull request reviewers IDs. A reviewer ID can be obtained by running the 'azure-devops-user-list' command. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PullRequest.repository.project.name | String | The name of the project. |
AzureDevOps.PullRequest.repository.id | String | The ID of the repository. |
AzureDevOps.PullRequest.repository.name | String | The name of the repository. |
AzureDevOps.PullRequest.repository.url | String | The URL of the repository. |
AzureDevOps.PullRequest.repository.size | Number | The size of the repository. |
AzureDevOps.PullRequest.pullRequestId | Number | The ID of the pull request. |
AzureDevOps.PullRequest.status | String | The status of the pull request. |
AzureDevOps.PullRequest.createdBy.displayName | String | The display name of the pull request creator. |
AzureDevOps.PullRequest.createdBy.id | String | The ID of the pull request creator. |
AzureDevOps.PullRequest.createdBy.uniqueName | String | The unique name of the pull request creator. |
AzureDevOps.PullRequest.creationDate | Date | The creation date of the pull request, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PullRequest.title | String | The title of the pull request |
AzureDevOps.PullRequest.description | String | The description of the pull request. |
AzureDevOps.PullRequest.sourceRefName | String | The source branch of the pull request. |
AzureDevOps.PullRequest.targetRefName | String | The target branch of the pull request. |
AzureDevOps.PullRequest.mergeStatus | String | The current status of the pull request merge. |
AzureDevOps.PullRequest.isDraft | Boolean | Whether the pull request is a draft / WIP. |
AzureDevOps.PullRequest.lastMergeSourceCommit.commitId | String | The ID of the commit at the head of the source branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeSourceCommit.url | String | The REST URL for this resource. |
AzureDevOps.PullRequest.lastMergeTargetCommit.commitId | String | The ID of the commit at the head of the target branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeTargetCommit.url | String | The REST URL for this resource. |
#
Command Example!azure-devops-pull-request-create project="xsoar" repository_id="XXXX" source_branch="test-test" target_branch="main" title="Test xsoar" description="Demo pr" reviewers_ids="XXXX"
#
Context Example#
Human Readable Output#
Pull Request Information:
Title Description Created By Pull Request Id Repository Name Repository Id Project Name Project Id Creation Date Test xsoar Demo pr XSOAR User 1 70 xsoar XXXX xsoar xsoar-project 2021-11-30T08:56:55
#
azure-devops-pull-request-updateUpdate a pull request. At least one of the following arguments must be provided: title, description, or status.
#
Base Commandazure-devops-pull-request-update
#
InputArgument Name | Description | Required |
---|---|---|
project | The name or ID of the project. | Required |
repository_id | The repository ID of the pull request's target branch. A repository ID can be obtained by running the 'azure-devops-repository-list' command. | Required |
pull_request_id | The ID of the pull request to update. | Required |
title | The updated pull-request title. | Optional |
description | The updated pull-request description. | Optional |
status | The updated pull-request status. Possible values: "abandoned", "completed", and "active". Possible values are: abandoned, completed, active. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PullRequest.repository.project.name | String | The name of the project. |
AzureDevOps.PullRequest.repository.id | String | The ID of the repository. |
AzureDevOps.PullRequest.repository.name | String | The name of the repository. |
AzureDevOps.PullRequest.repository.url | String | The URL of the repository. |
AzureDevOps.PullRequest.repository.size | Number | The size of the repository. |
AzureDevOps.PullRequest.pullRequestId | Number | The ID of the pull request. |
AzureDevOps.PullRequest.status | String | The status of the pull request. |
AzureDevOps.PullRequest.createdBy.displayName | String | The display name of the pull request creator. |
AzureDevOps.PullRequest.createdBy.id | String | The ID of the pull request creator. |
AzureDevOps.PullRequest.createdBy.uniqueName | String | The unique name of the pull request creator. |
AzureDevOps.PullRequest.creationDate | Date | The creation date of the pull request, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PullRequest.title | String | The title of the pull request |
AzureDevOps.PullRequest.description | String | The description of the pull request. |
AzureDevOps.PullRequest.sourceRefName | String | The source branch of the pull request. |
AzureDevOps.PullRequest.targetRefName | String | The target branch of the pull request. |
AzureDevOps.PullRequest.mergeStatus | String | The current status of the pull request merge. |
AzureDevOps.PullRequest.isDraft | Boolean | Whether the pull request is a draft / WIP. |
AzureDevOps.PullRequest.lastMergeSourceCommit.commitId | String | The ID of the commit at the head of the source branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeSourceCommit.url | String | The REST URL for this resource. |
AzureDevOps.PullRequest.lastMergeTargetCommit.commitId | String | The ID of the commit at the head of the target branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeTargetCommit.url | String | The REST URL for this resource. |
#
Command Example!azure-devops-pull-request-update project="xsoar" repository_id="XXXX" pull_request_id="70" title="New title"
#
Context Example#
Human Readable Output#
Pull Request Information:
Title Description Created By Pull Request Id Repository Name Repository Id Project Name Project Id Creation Date New title Demo pr XSOAR User 1 70 xsoar XXXX xsoar xsoar-project 2021-11-30T08:56:55
#
azure-devops-pull-request-listRetrieve pull requests in repository.
#
Base Commandazure-devops-pull-request-list
#
InputArgument Name | Description | Required |
---|---|---|
project | The name or ID of the project which the pull requests belongs to. | Required |
repository | The name of the repository pull request's target branch. | Required |
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PullRequest.repository.project.name | String | The name of the project. |
AzureDevOps.PullRequest.repository.id | String | The ID of the repository. |
AzureDevOps.PullRequest.repository.name | String | The name of the repository. |
AzureDevOps.PullRequest.repository.url | String | The URL of the repository. |
AzureDevOps.PullRequest.pullRequestId | Number | The ID of the pull request. |
AzureDevOps.PullRequest.status | String | The status of the pull request. |
AzureDevOps.PullRequest.createdBy.displayName | String | The display name of the pull request creator. |
AzureDevOps.PullRequest.createdBy.id | String | The ID of the pull request creator. |
AzureDevOps.PullRequest.createdBy.uniqueName | String | The unique name of the pull request creator. |
AzureDevOps.PullRequest.creationDate | Date | The creation date of the pull request, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PullRequest.title | String | The title of the pull request |
AzureDevOps.PullRequest.description | String | The description of the pull request. |
AzureDevOps.PullRequest.sourceRefName | String | The source branch of the pull request. |
AzureDevOps.PullRequest.targetRefName | String | The target branch of the pull request. |
AzureDevOps.PullRequest.mergeStatus | String | The current status of the pull request merge. |
AzureDevOps.PullRequest.isDraft | Boolean | Whether the pull request is a draft / WIP. |
AzureDevOps.PullRequest.lastMergeSourceCommit.commitId | String | The ID of the commit at the head of the source branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeSourceCommit.url | String | The REST URL for this resource. |
AzureDevOps.PullRequest.lastMergeTargetCommit.commitId | String | The ID of the commit at the head of the target branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeTargetCommit.url | String | The REST URL for this resource. |
#
Command Example!azure-devops-pull-request-list project="xsoar" repository="xsoar" page="1" limit="2"
#
Context Example#
Human Readable Output#
Pull Request List:Current page size: 2 Showing page 1 out others that may exist. |Title|Description|Created By|Pull Request Id|Repository Name|Repository Id|Project Name|Project Id|Creation Date| |---|---|---|---|---|---|---|---|---| | Test xsoar | Demo pr | XSOAR User 1 | 70 | xsoar | XXXX | xsoar | xsoar-project | 2021-11-30T08:56:55 | | Test xsoar | Demo pr | XSOAR User 1 | 65 | xsoar | XXXX | xsoar | xsoar-project | 2021-11-28T16:08:09 |
#
azure-devops-project-listRetrieve all projects in the organization that the authenticated user has access to.
#
Base Commandazure-devops-project-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.Project.name | String | The name of the project. |
AzureDevOps.Project.state | String | The state of the project. |
AzureDevOps.Project.revision | Number | The revision number of the project. |
AzureDevOps.Project.visibility | String | Indicates whom the project is visible to. |
AzureDevOps.Project.lastUpdateTime | Date | The project last update time, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.Project.id | String | The ID of the Project. |
#
Command Example!azure-devops-project-list page="1" limit="50"
#
Context Example#
Human Readable Output#
Project List:Current page size: 50 Showing page 1 out others that may exist. |Name|Id|State|Revision|Visibility|Last Update Time| |---|---|---|---|---|---| | xsoar | xsoar-project | wellFormed | 11 | private | 2021-10-13T15:46:18.017000+00:00 |
#
azure-devops-repository-listRetrieve git repositories in the organization project.
#
Base Commandazure-devops-repository-list
#
InputArgument Name | Description | Required |
---|---|---|
project | The name or ID of the project to which the repositories belong to. | Required |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.Project.name | String | The name of the project. |
AzureDevOps.Repository.id | String | The ID of the repository. |
AzureDevOps.Repository.name | String | The name of the repository. |
AzureDevOps.Repository.webUrl | String | The web URL of the repository. |
AzureDevOps.Repository.size | Number | The size of the repository (in bytes). |
#
Command Example!azure-devops-repository-list project="xsoar" limit="1" page="1"
#
Context Example#
Human Readable Output#
Repositories List:Current page size: 1 Showing page 1 out others that may exist. |Id|Name|Web Url|Size ( Bytes )| |---|---|---|---| | xsoar-repository | test2803 | https://dev.azure.com/xsoar-organization/xsoar/_git/test2803 | 0 |
#
azure-devops-user-listQuery users that were added to organization projects.
#
Base Commandazure-devops-user-list
#
InputArgument Name | Description | Required |
---|---|---|
query | Users or organization query prefix. For example, if you want to retrieve information about the user 'Tom', you can enter the value of this argument as 'Tom'. | Required |
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.User.entityType | String | The type of the entity. |
AzureDevOps.User.localId | String | The ID of the identity. |
AzureDevOps.User.signInAddress | String | The email address of the user. |
#
Command Example!azure-devops-user-list query="ofek"
#
Context Example#
Human Readable Output#
Users List:Current page size: 50 Showing page 1 out others that may exist. |Email|Entity Type|Id| |---|---|---| | user1@xsoar.com | User | XXXX | | user2@xsoar.com | User | XXXX |
#
azure-devops-pull-request-getRetrieve pull-request.
#
Base Commandazure-devops-pull-request-get
#
InputArgument Name | Description | Required |
---|---|---|
project | The name or ID of the project. | Required |
repository_id | The repository ID of the pull request's target branch. A repository ID can be obtained by running the 'azure-devops-repository-list' command. | Required |
pull_request_id | The ID of the pull request to retrieve. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PullRequest.repository.project.name | String | The name of the project. |
AzureDevOps.PullRequest.repository.id | String | The ID of the repository. |
AzureDevOps.PullRequest.repository.name | String | The name of the repository. |
AzureDevOps.PullRequest.repository.url | String | The URL of the repository. |
AzureDevOps.PullRequest.repository.size | Number | The size of the repository. |
AzureDevOps.PullRequest.pullRequestId | Number | The ID of the pull request. |
AzureDevOps.PullRequest.status | String | The status of the pull request. |
AzureDevOps.PullRequest.createdBy.displayName | String | The display name of the pull request creator. |
AzureDevOps.PullRequest.createdBy.id | String | The ID of the pull request creator. |
AzureDevOps.PullRequest.createdBy.uniqueName | String | The unique name of the pull request creator. |
AzureDevOps.PullRequest.creationDate | Date | The creation date of the pull request, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PullRequest.title | String | The title of the pull request |
AzureDevOps.PullRequest.description | String | The description of the pull request. |
AzureDevOps.PullRequest.sourceRefName | String | The source branch of the pull request. |
AzureDevOps.PullRequest.targetRefName | String | The target branch of the pull request. |
AzureDevOps.PullRequest.mergeStatus | String | The current status of the pull request merge. |
AzureDevOps.PullRequest.isDraft | Boolean | Whether the pull request is a draft / WIP. |
AzureDevOps.PullRequest.lastMergeSourceCommit.commitId | String | The ID of the commit at the head of the source branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeSourceCommit.url | String | The REST URL for the merge source commit. |
AzureDevOps.PullRequest.lastMergeTargetCommit.commitId | String | The ID of the commit at the head of the target branch at the time of the last pull request merge. |
AzureDevOps.PullRequest.lastMergeTargetCommit.url | String | The REST URL for the merge target commit. |
#
Command Example!azure-devops-pull-request-get project="xsoar" repository_id="XXXX" pull_request_id="70"
#
Context Example#
Human Readable Output#
Pull Request Information:
Title Description Created By Pull Request Id Repository Name Repository Id Project Name Project Id Creation Date Test xsoar Demo pr XSOAR User 1 70 xsoar XXXX xsoar xsoar-project 2021-11-30T08:56:55
#
azure-devops-pipeline-run-getRetrieve information for a pipeline run.
#
Base Commandazure-devops-pipeline-run-get
#
InputArgument Name | Description | Required |
---|---|---|
project | The name of the project. | Required |
pipeline_id | The ID of the pipeline to retrieve. | Required |
run_id | The ID of the pipeline run to retrieve. | Required |
scheduled | Indicates if the command was scheduled. Possible values are: True, False. Default is False. | Optional |
interval | Indicates how long to wait between command execution (in seconds) when 'polling' argument is true. Minimum value is 10 seconds. Default is 30. | Optional |
timeout | Indicates the time in seconds until the polling sequence timeouts. Default is 60. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PipelineRun.project | String | The name of the project. |
AzureDevOps.PipelineRun.pipeline.id | Number | The ID of the pipeline. |
AzureDevOps.PipelineRun.pipeline.name | String | Pipeline repository name. |
AzureDevOps.PipelineRun.state | String | The run state. |
AzureDevOps.PipelineRun.createdDate | Date | The run creation date, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PipelineRun.run_id | Number | The ID of the run. |
AzureDevOps.PipelineRun.name | String | The name of the run. |
AzureDevOps.PipelineRun.result | String | The result of the pipeline running. If the run is in progress, the default value is 'unknown'. |
#
Command Example!azure-devops-pipeline-run-get project="xsoar" pipeline_id="1" run_id="114"
#
Context Example#
Human Readable Output#
Pipeline Run Information:
Pipeline Id Run State Creation Date Run Id Result 1 completed 2021-11-07T08:09:03.592213+00:00 114 failed
#
azure-devops-pipeline-run-listRetrieve pipeline runs list. The command retrieves up to the top 10000 runs for a particular pipeline.
#
Base Commandazure-devops-pipeline-run-list
#
InputArgument Name | Description | Required |
---|---|---|
project | The name of the organization project. | Required |
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
pipeline_id | The ID of the pipeline which the runs belongs to. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.PipelineRun.project | String | The name of the project. |
AzureDevOps.PipelineRun.pipeline.id | Number | The ID of the pipeline. |
AzureDevOps.PipelineRun.pipeline.name | String | Pipeline repository name |
AzureDevOps.PipelineRun.state | String | The run state. |
AzureDevOps.PipelineRun.createdDate | Date | The run creation date, using ISO 8601 format in UTC time. For example, midnight UTC on Jan 1, 2022 would be: "2022-01-01T00:00:00Z". |
AzureDevOps.PipelineRun.run_id | Number | The ID of the run. |
AzureDevOps.PipelineRun.name | String | The name of the run. |
AzureDevOps.PipelineRun.result | String | The result of the pipeline running. If the run is in progress, the default value is 'unknown'. |
#
Command Example!azure-devops-pipeline-run-list project="xsoar" page="1" limit="1" pipeline_id="1"
#
Context Example#
Human Readable Output#
Pipeline runs List:Current page size: 1 Showing page 1 out others that may exist. |Pipeline Id|Run State|Creation Date|Run Id|Result| |---|---|---|---|---| | 1 | inProgress | 2021-11-30T08:57:03.110121+00:00 | 1154 | unknown |
#
azure-devops-pipeline-listRetrieve project pipelines list.
#
Base Commandazure-devops-pipeline-list
#
InputArgument Name | Description | Required |
---|---|---|
project | The name of the organization project. | Required |
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.Pipeline.project | String | The name of the project. |
AzureDevOps.Pipeline.id | Number | The ID of the pipeline. |
AzureDevOps.Pipeline.revision | Number | Pipeline revision number. |
AzureDevOps.Pipeline.name | String | Pipeline name. |
AzureDevOps.Pipeline.folder | String | Pipeline folder. |
#
Command Example!azure-devops-pipeline-list project="xsoar" page="1" limit="1"
#
Context Example#
Human Readable Output#
Pipelines List:Current page size: 1 Showing page 1 out others that may exist. |Id|Name|Revision|Folder| |---|---|---|---| | 2 | xsoar (1) | 1 | \ |
#
azure-devops-branch-listRetrieve repository branches list.
#
Base Commandazure-devops-branch-list
#
InputArgument Name | Description | Required |
---|---|---|
project | The name of the organization project. | Required |
repository | The name of the project repository. | Required |
page | The page number of the results to retrieve. Minimum value is 1. Default is 1. | Optional |
limit | The number of results to retrieve. Minimum value is 1. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
AzureDevOps.Branch.project | String | The name of the project. |
AzureDevOps.Branch.repository | String | The name of the repository. |
AzureDevOps.Branch.name | String | The name of the branch. |
#
Command Example!azure-devops-branch-list project="xsoar" repository="xsoar" page="1" limit="1"
#
Context Example#
Human Readable Output#
Branches List:Current page size: 1 Showing page 1 out others that may exist. |Name| |---| | refs/heads/main |