purviewcli

Microsoft Purview CLI

This package provides a command line interface to Microsoft Purview's REST API.

Getting Started

Getting Started - how to install, setup, and use purviewcli.

Installation

pip install purviewcli

Usage

pv command sub-command --parameter1='value' --parameter2='value'

Parameter Types

• All parameters are required by default.
• Parameters enclosed with square brackets "[ ]" are optional.
• Mutually exclusive parameters are enclosed with parens "( )" and separated with a pipe "|".
• The "=<val>" indicates parameters which require an input (e.g. --parameter=<val>). Input can be specified after a space (e.g. --parameter 'value') or equal "=" sign (e.g. --parameter='value').
• Parameters that do not require an input are False by default and True if present (e.g. --ignoreRelationships).
• The ellipsis "..." indicates parameters that are allowed to repeat (e.g. --guid='12345' --guid='23451' --guid='34512')

Command Reference

Control Plane (Azure Resource Manager)

Command	Surface Area
pv management	Account, Private Endpoint, Other

Data Plane (Apache Atlas)

Command	Surface Area
pv entity	Business Attribute, Business Metadata, Label, Classification, Entity
pv glossary	Glossary, Terms, Categories
pv lineage	Lineage
pv relationship	Relationship
pv types	Classification, Entity, Enum, Relationship, Struct, Term Template

Data Plane (Other)

Command	Surface Area
pv account	Account, Collection, Resource Set Rule
pv insight	Asset, Scan
pv policystore	Metadata Policies, Data Policies
pv scan	Classification Rule, Credential, Source, Scan, Filter, Ruleset, Trigger
pv search	Search
pv share	Shares, Invitations, Mappings, Assets