topic hubofficial - Microsoftreviewed - checked by Opus

App Management

App Management covers the App Management API and how ISVs use it to manage Business Central app deployments, updates, and customer environments. It answers questions about the API entities, ISV update workflows, and upgrading apps with breaking changes using ForceSync.

Path: Get started > Develop > Embed apps > App Management · tier official · system none · narrative reviewed (checked by Opus)

Overview

App Management is for ISVs who publish Business Central apps and need to manage them across many customer deployments. The section has three pages: an ISV-oriented overview, a reference for the API itself, and a procedure for a specific upgrade case.

Start with “App Management for ISVs” to see how the API supports app updates, the app repository, customer environment management, hotfix deployment, and continuous integration. Then use “App Management API” as the reference for the REST endpoints and entities. Read “Updating an App Version by Using ForceSync” when an update contains breaking changes and needs the ForceSync sync mode.

Key points

  • The App Management API exposes REST endpoints with create, read, update, and delete operations.
  • API entities: App, Country, Principal, Version, Environment, and Environment Hotfix.
  • The ISV overview covers app updates, the app repository, customer environment management, and hotfix deployment.
  • The API can be used in continuous integration scenarios across multiple Business Central deployments.
  • ForceSync is a sync mode for upgrading apps that have breaking changes, through schema synchronization.
  • The ForceSync page refers to Microsoft Lifecycle Services and side-by-side upgrades.
  • ForceSync updates need careful testing before they are used in production.

Learn pages

Source: Microsoft Learn (CC BY 4.0). Descriptions are Learn’s own.

What Learn documents here 3 Learn pages