Skip to content

AVMPostDeploymentGuide.md

Latest commit

 

History

History
115 lines (72 loc) · 5.1 KB

AVMPostDeploymentGuide.md

File metadata and controls

115 lines (72 loc) · 5.1 KB

AVM Post Deployment Guide

📋 Note: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch using azd, see the main Deployment Guide.

This document provides guidance on post-deployment steps after deploying the Content Processing Solution Accelerator from the AVM (Azure Verified Modules) repository.

Overview

After successfully deploying the Content Processing Solution Accelerator using the AVM template, you need to:

  1. Register schemas — upload schema files, create a schema set, and link them together
  2. Process sample files — upload and process sample claim bundles for verification
  3. Configure authentication — set up app registration for secure access

Note: When deploying via azd up, schema registration and sample processing happen automatically through a post-provisioning hook. AVM deployments require the manual steps below.

Prerequisites

Before starting, ensure you have:

Required Software

  1. Python (v3.10+) — Required to run the schema registration script
  2. Azure CLI (v2.50+) — Command-line tool for managing Azure resources
  3. Git — Version control system for cloning the repository
  4. Deployed Infrastructure — A successful Content Processing Solution Accelerator deployment from the AVM repository

Python Dependencies

The registration script requires the requests library:

pip install requests

Post-Deployment Steps

Step 1: Clone the Repository

Clone this repository to access the schema files and registration script:

git clone https://github.com/microsoft/content-processing-solution-accelerator.git
cd content-processing-solution-accelerator

Step 2: Get Your API Endpoint

Locate the API container app's FQDN from your deployment output or the Azure Portal:

  • Navigate to Azure Portal → Resource Group → Container Apps
  • Find the container app named ca-<your-environment>-api
  • Copy the Application URL (e.g. https://ca-myenv-api.<region>.azurecontainerapps.io)

Step 3: Register Schemas and Create Schema Set

The registration script performs three steps automatically:

  1. Registers individual schema files (auto claim, damaged car image, police report, repair estimate) via /schemavault/
  2. Creates an "Auto Claim" schema set via /schemasetvault/
  3. Adds all registered schemas into the schema set

Run the script:

cd src/ContentProcessorAPI/samples/schemas
python register_schema.py https://<API_ENDPOINT> schema_info.json

Replace <API_ENDPOINT> with the URL from Step 2 (without a trailing slash).

The script is idempotent — it skips schemas and schema sets that already exist, so it's safe to re-run.

Want custom schemas? See Customize Schema Data to create your own document schemas.

Step 4: Process Sample File Bundles (Optional)

After schema registration, you can upload and process the included sample claim bundles to verify the deployment is working end to end. Each sample folder (claim_date_of_loss/, claim_hail/) contains a bundle_info.json manifest that maps files to their schema classes.

The workflow for each bundle:

  1. Create a claim batch with the schema set ID via PUT /claimprocessor/claims
  2. Upload each file with its mapped schema ID via POST /claimprocessor/claims/{claim_id}/files
  3. Submit the batch for processing via POST /claimprocessor/claims

You can perform these steps via the web UI or the API directly. See the API documentation and Golden Path Workflows for details.

Note: When deploying via azd up, sample file processing happens automatically as Step 4 of the post-provisioning hook.

Step 5: Configure Authentication (Required)

This step is mandatory for application access:

  1. Follow App Authentication Configuration.
  2. Wait up to 10 minutes for authentication changes to take effect.

Step 6: Verify Deployment

  1. Access your application using the Web App URL from your deployment output.
  2. Confirm the application loads successfully.
  3. Verify you can sign in with your authenticated account.

Next Steps

Once configuration is complete:

Need Help?