Add ability to force a sync from an APIM integration
- Dominant language
- PowerShell
- Stars
- 45
- Forks
- 21
- Avg merge
- 21m
- Merged PRs (30d)
- 1
Description
# What are you trying to achieve?
I have run into an issue before with syncs from an APIM integration seemingly failing. There is no visibility into what happens during a sync so I can't say it technically failed but the sync never occurs. Recently I have the same issue across 3 separate environments. I had previously opened an issue with Microsoft about this and the final resolution proposed was to remove the sync link and re-add it. This did fix it but it can't be a final solution.
# Proposed solution
I propose the user should be able to force an immediate sync and that the outcome of forcing a sync can indicate whether the sync was successful or failed. There are times when the duration of the sync does not matter such as the day-to-day deployment of a new API to APIM. In these cases the 24hrs sync isn't as much of a concern but there are other times when you are developing new solutions that depend on the synced data and it is unacceptable to wait 24hrs for a sync. It is also unacceptable to not know whether data is successfully syncing or not, especially when the duration is so long. You can end up waiting 24hrs only to find out that nothing has changed.
# Alternative solutions
An alternative would be to show successful syncs along with their times and, if possible, the expected time of the next sync.
# Additional context
I have confirmed that the number of assets is not the cause of the problem. The linked APIM instances and the API Center have fewer than 200 total assets.
Contributor guide
No contributing guide indexed for this repository
Research direction
No files or tests are named. Start by locating the APIM integration and its existing sync flow, then review how sync outcomes are currently surfaced. Done should include a user-invokable immediate sync and a clear success or failure result, with the behavior covered by the project's relevant tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- api, cloud
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100