Azure APIM APIOps

Question

Azure APIM APIOps

jhansi nallamothu 20

Hi Team,

I am trying to run the APIOps toolkit with Azure DevOps by following this doc :

We are just a beginner to this tool, so while running the run-extractor.yml file getting artifacts but when creating a pull request not getting tags folder and products folder. Getting tags and product folders are in artifacts and template branch also. I have tried with config extractor file also but that is not working. Could you please help me to resolve the issue.

Thanks & Regards

Jhansi Nallamothu

Rakesh Mishra 9,425 Reputation points Microsoft External Staff Moderator

2025-08-30T07:46:52.2933333+00:00
Hi jhansi nallamothu,

Welcome to the Microsoft Q&A Platform! Thank you for asking your question here.

The pipeline is correctly extracting tags and products, but it is not staging, committing, and pushing those folders into the Git feature branch before creating the pull request. Common causes include:

The Git working directory not being checked out with persisted credentials.

Missing or mis-configured Git tasks (git add, git commit, git push).

Pushing to the wrong branch or using incorrect branch names.

Insufficient permissions in the pipeline’s service connection to commit or create PRs.

Steps

Verify Checkout Configuration

Open your pipeline, edit the YAML.

Ensure the checkout step is defined with persistCredentials: true. Azure CLI / YAML:

resources: repositories: - repository: self type: git steps: - checkout: self persistCredentials: true clean: true

Stage Generated Folders After the extractor task, add steps to verify and stage the new folders:
- script: | echo "Contents of extracted folders:" ls -R tags products displayName: 'List extracted tags and products' - script: | git config user.name "APIOps Bot" git config user.email "******@contoso.com" git add tags products git status displayName: 'Stage tags and products'

Commit and Push Changes Include an explicit commit & push step, targeting the feature branch used for PR:
- script: | git commit -m "APIOps: add extracted tags and products" git push origin HEAD:refs/heads/$(Build.SourceBranchName) displayName: 'Commit and push extracted content'

Create or Update the Pull Request Use the Azure DevOps REST API or built-in task to create the PR, ensuring it picks up the latest commit:
- task: AzureCLI@2 inputs: azureSubscription: 'YourServiceConnection' scriptType: bash scriptLocation: inlineScript inlineScript: | az repos pr create \ --organization https://dev.azure.com/contoso \ --project "MyProject" \ --repository "$(Build.Repository.Name)" \ --source-branch "$(Build.SourceBranchName)" \ --target-branch "master" \ --title "APIOps: sync tags & products" \ --description "Automated PR from APIOps extractor" displayName: 'Create Pull Request'

Ensure Permissions

Confirm the pipeline’s service connection has “Contribute” and “Create pull request” permissions on the target repo and branches.

Check branch policies do not block the bot’s account from pushing commits or creating PRs.

Validate Extractor Configuration

In your extractor config (often apiops.config.json), ensure no exclusion filters omit tags or products.

Example snippet:

{ "extractor": { "outputFolder": "apim-template", "includeTags": true, "includeProducts": true } }

Points to Consider

Performance implications: staging large numbers of files can increase pipeline runtime; consider targeting only changed files if extraction outputs are static.

Best practices: always use persistCredentials: true on checkout to allow Git pushes.

Alternative approach: use the Azure DevOps Git task (e.g., GitPush@0 and PullRequest@1) if you prefer built-in tasks over script steps.

Prerequisites: ensure the Azure DevOps project’s security settings permit your service principal or pipeline agent to push commits and create PRs.
jhansi nallamothu 20 Reputation points

2025-08-30T21:49:28.28+00:00

Hi Rakesh,

Thank you for your quick response.

I have used run extractor yaml from GitHub. Could you please guide me where exactly need to add to get tags and products in pull request
Rakesh Mishra 9,425 Reputation points Microsoft External Staff Moderator

2025-09-02T17:56:35.5366667+00:00

Hi @jhansi nallamothu, could you please confirm if you are running extractor pipeline for the first time or it has run earlier also.

If it has run earlier and there are no changes in artifacts and default branch (main/master), it will not come in PR.

Please share the logs from pipeline for step - Create artifacts pull request. Also, file comparison in PR.
jhansi nallamothu 20 Reputation points

2025-09-03T06:24:22.8766667+00:00

Hi Rakesh,

Can we connect for teams call to have more clarity on this issue. This will help you to get more insights about the problem which we are facing and also about our requirement.

Thanks & Regards

Jhansi Nallamothu
Rakesh Mishra 9,425 Reputation points Microsoft External Staff Moderator

2025-09-03T08:55:30.8+00:00

Hi jhansi nallamothu, please share the requested information over Private Messages.

Answer accepted by question author

0 additional answers

Your answer

jhansi nallamothu 20 Reputation points

2025-08-30T21:49:28.28+00:00

Hi Rakesh,

Thank you for your quick response.

I have used run extractor yaml from GitHub. Could you please guide me where exactly need to add to get tags and products in pull request
Rakesh Mishra 9,425 Reputation points Microsoft External Staff Moderator

2025-09-02T17:56:35.5366667+00:00

Hi @jhansi nallamothu, could you please confirm if you are running extractor pipeline for the first time or it has run earlier also.

If it has run earlier and there are no changes in artifacts and default branch (main/master), it will not come in PR.

Please share the logs from pipeline for step - Create artifacts pull request. Also, file comparison in PR.
jhansi nallamothu 20 Reputation points

2025-09-03T06:24:22.8766667+00:00

Hi Rakesh,

Can we connect for teams call to have more clarity on this issue. This will help you to get more insights about the problem which we are facing and also about our requirement.

Thanks & Regards

Jhansi Nallamothu
Rakesh Mishra 9,425 Reputation points Microsoft External Staff Moderator

2025-09-03T08:55:30.8+00:00

Hi jhansi nallamothu, please share the requested information over Private Messages.

Answer 1

Rakesh Mishra 9,425 Microsoft External Staff Moderator

Hi jhansi nallamothu,

Based on the discussion, below is the summary of issue and resolution.

Issue: The extractor was run first time, and PR was merged which had put the artifacts in the target branch. When every new extractor run was happening, since there was no new change in tags and products, it was not coming in pull request.

Resolution: we created a fresh branch from main and put that as a target branch. Since there were no artifacts in that branch, all the changes were reflecting in the pull request.

0 comments

Share via

Azure APIM APIOps

Steps

Points to Consider

0 additional answers

Your answer