Common Workflows

Use this page when you know the outcome you want, but do not want to browse the full command catalog.

Start With The Workflow, Not The Command

• First successful command

Install the CLI, authenticate with Azure, and verify your environment.

Open guide

• Route to the right family

Choose between entity, glossary, scan, account, management, and Unified Catalog.

Open guide

• Bulk CSV ingestion

High-volume entity create and update with the right operating profile.

Open guide

• Retry and repair failures

Fix throttling, schema errors, and malformed input files.

Open guide

Workflow 1: Find An Asset And Read Its Metadata

Use this when you know a keyword, qualified name fragment, or general subject area.

pvw search query --keywords "customer"
pvw entity read --guid <entity-guid>

Go deeper with:

• Search commands
• Entity commands

Workflow 2: Create Or Update Assets In Bulk

Use this when your source of truth is CSV or structured metadata exports.

pvw entity --help

Then continue with:

• Entity Bulk CSV Guide
• Import Tasks
• Bulk CSV Troubleshooting

Workflow 3: Manage Glossary Terms And Categories

Use this when you are building business vocabulary, assigning terms, or importing term sets.

pvw glossary readTerms
pvw glossary createTerm --help
pvw glossary createTermsImport --help

Go deeper with:

• Glossary commands
• Create Tasks
• Update Tasks

Workflow 4: Configure Scans And Run Them

Use this when onboarding a source, updating credentials, changing rulesets, or triggering scans.

pvw scan putdatasource --help
pvw scan putscan --help
pvw scan runscan --help

Go deeper with:

• Scan commands
• Authentication Troubleshooting

Workflow 5: Manage Collections Or Purview Account Settings

Use this split when you are unsure whether the task is account or management.

• Use account for collections, collection paths, and resource set rules.
• Use management for Purview account resources, private endpoints, keys, and default account settings.

Workflow 6: Work In Unified Catalog

Use this when your task is centered on domains, terms, data products, objectives, key results, CDEs, or quality reporting.

pvw uc --help
pvw uc term list
pvw uc domain list
pvw uc dataproduct list

Go deeper with:

• Unified Catalog guide
• Quick reference
• Unified Catalog commands

Pick The Right Task Guide

• Create resources and entities: Create Tasks
• Update resources and metadata: Update Tasks
• Delete resources and cleanup: Delete Tasks
• Import and bulk ingest: Import Tasks

Bulk CSV Operating Profiles

• Fast: highest throughput when the tenant is stable and throttling is low
• Balanced: default choice for most environments
• Safe: lowest risk when throttling, large payloads, or service sensitivity are concerns

For exact flags, command examples, and tuning guidance, use Entity Bulk CSV Guide.