Preflight checks for Microsoft Azure Cosmos DB for NoSQL
Before running the Microsoft Azure Cosmos DB for NoSQL crawler, you can run preflight checks to perform the necessary technical validations.
The checks run in order against the first account Atlan can reach, and each check reports whether it passed along with a message describing the result. The following preflight checks are completed:
Account connectivity
Validates that Atlan can authenticate with the service principal credentials you provided and reach at least one Cosmos DB for NoSQL account.
If this check fails, no further checks run. Confirm that:
- The tenant ID, client ID, and client secret are correct, and the client secret hasn't expired.
- The service principal has the Cosmos DB Account Reader Role on at least one account.
- If your accounts restrict public network access, Atlan's IP range is allowed.
Read metadata
Validates that Atlan can list the databases in the account, which is required to select the accounts and databases to crawl.
A failure here usually means the service principal can see the account but not its contents. Confirm the role assignment was made at account scope and has finished propagating—role changes can take up to a minute to take effect.
Container read
Validates that Atlan can read the properties of a container, such as its partition key paths.
If the first database Atlan reaches has no containers, this check is skipped and reported as passed.
Execute query
Validates that Atlan can run a query against a container, which is how Atlan samples items to infer field schemas.
If this check fails while the previous checks pass, the service principal can read structural metadata but not container items. Crawls can still catalog accounts, databases, containers, and scripts, but column information won't be available.
See also
- Crawl Microsoft Azure Cosmos DB for NoSQL: Configure and run metadata extraction from your accounts.
- Set up Microsoft Azure Cosmos DB for NoSQL: Create a service principal and grant it access.