Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Diagram of the sequence of the deployment guide including these locations, in order: Overview, Plan, Prepare, Publish, Monitor, and Optimization. The 'Prepare' location is currently highlighted.
There are multiple options available to host Data API builder in Azure or on your own infrastructure. Review these options to select the appropriate hosting options for your Data API builder solution.
Azure Container Apps
Azure Container Apps is an Azure service that hosts a cluster of Docker container images on your behalf. Azure Container Apps is a serverless platform that balances complexity with configuration by reducing the friction to have a container cluster. Azure Container Apps fully manages the details around infrastructure, orchestration, and deployment. Use Azure Container Apps to host a container cluster that can scale out or in quickly and also support multiple container workloads.
Create Azure Container Apps environments that include container[s] instances running Data API builder. These environments could also conceivably include your application instances running in close proximity to the API instances.
For more information, see Azure Container Apps.
Azure Container Instances
Azure Container Instances is an Azure service that hosts an individual Docker container image on your behalf. Azure Container Instances is a serverless platform that is a low-friction way of getting a container instance running in Azure without the complexity of a higher-level service. Use Azure Container Instances to quickly deploy a container without worrying about complex clusters or configuration.
Host Data API builder in an Azure Container Instance resource within a container group to have a low-friction method of running the engine. Consider taking advantage of the virtual networking functionality by hosting your application instances within the same container group.
For more information, see Azure Container Instances.
Azure App Service
Azure App Service is an Azure service that hosts web applications or APIs either running in server-side code or a Docker container. Azure App Service is ideal for complex languages using your preferred programming language server-side. Azure App Service natively supports .NET, Java, Node.js, PHP, and Python applications. You can also support a myriad of extra frameworks and engines using Docker container images, Azure App Service.
You can run Data API builder as either a [native .NET application]/azure/app-service/configure-language-dotnetcore) or a Docker container image. Alternatively, you can create a multi-container-app using Docker Compose that deploys Data API builder as a sidecar container to an application running your preferred stack.
For more information, see Azure App Service.
Azure Kubernetes Service
Azure Kubernetes Service is an Azure service that manages a Kubernetes cluster on your behalf. Azure Kubernetes Service is a manage service that handles the infrastructure for your Kubernetes solution while still exposing the individual components for further customizations. Azure Kubernetes Service supports the usage of common Kubernetes manifest files and command-line interfaces so you can apply any existing knowledge or skills about the platform.
Run Data API builder as part of a Kubernetes container cluster and allow Azure Kubernetes Service to manage the individual hosts at scale. Consider hosting your applications and API clusters in a manner where they are in close proximity and performant, while being allowed to scale independently using typical Kubernetes control mechanisms.
For more information, see Azure Kubernetes Service.
Azure Static Web Apps (preview)
Important
Support for Data API builder (DAB) in Azure Static Web Apps using database connections is in preview. Azure Static Web Apps uses a fixed version of the DAB engine that can vary from the latest stable version of DAB. To access the latest DAB features, consider an alternative host for DAB using the latest version of the engine from GitHub, Microsoft Container Registry (Docker Hub), or NuGet.
Azure Static Web Apps is an Azure service that automatically builds and deploys full stack static web applications from a source control repository to a host in Azure. Azure Static Web Apps is ideal for solutions that are source controlled, built using an automation workflow, and then runs statically in the final hosting service. Use Azure Static Web Apps for applications that result in HTML, CSS, and JavaScript where server-side processing or rendering isn't required.
Data API builder runs as a sidecar service to a static web app. The database connections feature uses a fixed version of the Data API builder engine and can be optionally configured on any static web app.
For more information, see Azure Static Web Apps.