Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tayganr/purviewcli
Microsoft Purview CLI
https://github.com/tayganr/purviewcli
azure azure-purview purview-cli
Last synced: 2 days ago
JSON representation
Microsoft Purview CLI
- Host: GitHub
- URL: https://github.com/tayganr/purviewcli
- Owner: tayganr
- License: mit
- Created: 2020-12-31T12:04:29.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T17:56:40.000Z (about 1 year ago)
- Last Synced: 2024-04-14T03:05:09.326Z (10 months ago)
- Topics: azure, azure-purview, purview-cli
- Language: Python
- Homepage: https://aka.ms/purviewcli
- Size: 5.47 MB
- Stars: 44
- Watchers: 9
- Forks: 27
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Microsoft Purview CLI
This package provides a command line interface to Microsoft Purview's REST API.
## Getting Started
[Getting Started](./doc/md/guide.md) - 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](./doc/commands/management/main.md) | `Account`, `Private Endpoint`, `Other` |
Data Plane (Apache Atlas)
| Command | Surface Area |
| --- | --- |
| [pv entity](./doc/commands/entity/main.md) | `Business Attribute`, `Business Metadata`, `Label`, `Classification`, `Entity` |
| [pv glossary](./doc/commands/glossary/main.md) | `Glossary`, `Terms`, `Categories` |
| [pv lineage](./doc/commands/lineage/main.md) | `Lineage` |
| [pv relationship](./doc/commands/relationship/main.md) | `Relationship` |
| [pv types](./doc/commands/types/main.md) | `Classification`, `Entity`, `Enum`, `Relationship`, `Struct`, `Term Template` |
Data Plane (Other)
| Command | Surface Area |
| --- | --- |
| [pv account](./doc/commands/account/main.md) | `Account`, `Collection`, `Resource Set Rule` |
| [pv insight](./doc/commands/insight/main.md) | `Asset`, `Scan` |
| [pv policystore](./doc/commands/policystore/main.md) | `Metadata Policies`, `Data Policies` |
| [pv scan](./doc/commands/scan/main.md) | `Classification Rule`, `Credential`, `Source`, `Scan`, `Filter`, `Ruleset`, `Trigger` |
| [pv search](./doc/commands/search/main.md) | `Search` |
| [pv share](./doc/commands/share/main.md) | `Shares`, `Invitations`, `Mappings`, `Assets` |