Purview CLI Documentation¶
Purview CLI docs rebuilt around navigation, not file listings.
Start from what you need to do: install the CLI, choose the correct command family, follow a common workflow, or jump straight into the full reference.
Get started Find a command Browse command groups
Start With Your Goal¶
- Install and authenticate
Set up pvw-cli, sign in with Azure, and verify your first commands.
- Choose a command family
Map your task to the correct top-level group before reading detailed command docs.
- Follow common workflows
Use task-oriented paths for search, glossary work, scans, collections, and bulk ingestion.
- Run bulk CSV operations
Use the guided path for high-volume entity create and update operations.
- Work with Unified Catalog
Navigate domains, data products, terms, OKRs, CDEs, and quality reporting.
- Use Purview MCP Server
Run the MCP server and connect AI clients to Purview tools for guided governance workflows.
- Open the full reference
Browse every documentation page only when you need exhaustive coverage.
Command Families At A Glance¶
| If you need to... | Use | Start here |
|---|---|---|
| Query or browse the catalog | search | Search commands |
| Manage assets and metadata | entity | Entity commands |
| Manage glossaries, terms, and categories | glossary | Glossary commands |
| Configure scans, credentials, and rulesets | scan | Scan commands |
| Manage collections and resource set rules | account | Account commands |
| Manage Purview accounts and control-plane settings | management | Management commands |
| Inspect links between assets | relationship and lineage | Command groups |
| Work with modern governance objects | Unified Catalog | Unified Catalog guide |
Fast Paths¶
- New user: Getting Started
- Not sure where to begin: Which Command Should I Use?
- Need task-oriented guidance: Common Workflows
- Need exhaustive command coverage: Full Documentation Catalog
- Need examples and sample inputs: Full Samples Catalog
- Need MCP setup and usage: Purview MCP Server
Five-Minute Start¶
pip install pvw-cli
az login
pvw --help
pvw search query --keywords "customer"
pvw glossary readTerms
Use The Catalogs Last¶
The documentation and samples catalogs are still available, but they work best as exhaustive indexes after you already know the area you want. For faster navigation, start with Which Command Should I Use? or Command Groups.