# 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` |
Raw data
{
"_id": null,
"home_page": "https://github.com/tayganr/purviewcli",
"name": "purviewcli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Taygan Rifat",
"author_email": "contact@taygan.co",
"download_url": "https://files.pythonhosted.org/packages/17/8b/a4c922aea36e9962ad35c41fa4929a481bb52475b594d133362af859f020/purviewcli-0.3.2.tar.gz",
"platform": null,
"description": "# Microsoft Purview CLI\r\n\r\nThis package provides a command line interface to Microsoft Purview's REST API. \r\n\r\n\r\n## Getting Started\r\n\r\n[Getting Started](./doc/md/guide.md) - how to install, setup, and use purviewcli.\r\n\r\n## Installation\r\n\r\n```\r\npip install purviewcli\r\n```\r\n\r\n## Usage\r\n\r\n```\r\npv command sub-command --parameter1='value' --parameter2='value'\r\n```\r\n\r\n## Parameter Types\r\n\r\n* All parameters are required by default.\r\n* Parameters enclosed with square brackets \"**[ ]**\" are optional.\r\n* Mutually exclusive parameters are enclosed with parens \"**( )**\" and separated with a pipe \"**|**\".\r\n* 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').\r\n* Parameters that do not require an input are **False** by default and **True** if present (e.g. --ignoreRelationships).\r\n* The ellipsis \"**...**\" indicates parameters that are allowed to repeat (e.g. --guid='12345' --guid='23451' --guid='34512')\r\n\r\n## Command Reference\r\n\r\nControl Plane (Azure Resource Manager)\r\n\r\n| Command | Surface Area |\r\n| --- | --- |\r\n| [pv management](./doc/commands/management/main.md) | `Account`, `Private Endpoint`, `Other` |\r\n\r\nData Plane (Apache Atlas)\r\n\r\n| Command | Surface Area |\r\n| --- | --- |\r\n| [pv entity](./doc/commands/entity/main.md) | `Business Attribute`, `Business Metadata`, `Label`, `Classification`, `Entity` |\r\n| [pv glossary](./doc/commands/glossary/main.md) | `Glossary`, `Terms`, `Categories` |\r\n| [pv lineage](./doc/commands/lineage/main.md) | `Lineage` |\r\n| [pv relationship](./doc/commands/relationship/main.md) | `Relationship` |\r\n| [pv types](./doc/commands/types/main.md) | `Classification`, `Entity`, `Enum`, `Relationship`, `Struct`, `Term Template` |\r\n\r\nData Plane (Other)\r\n\r\n| Command | Surface Area |\r\n| --- | --- |\r\n| [pv account](./doc/commands/account/main.md) | `Account`, `Collection`, `Resource Set Rule` |\r\n| [pv insight](./doc/commands/insight/main.md) | `Asset`, `Scan` |\r\n| [pv policystore](./doc/commands/policystore/main.md) | `Metadata Policies`, `Data Policies` |\r\n| [pv scan](./doc/commands/scan/main.md) | `Classification Rule`, `Credential`, `Source`, `Scan`, `Filter`, `Ruleset`, `Trigger` |\r\n| [pv search](./doc/commands/search/main.md) | `Search` |\r\n| [pv share](./doc/commands/share/main.md) | `Shares`, `Invitations`, `Mappings`, `Assets` |\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This package provides a command line interface to Azure Purview's REST API.",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/tayganr/purviewcli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "937bb6528573b5709e657873dd140fe08ed0e78c9f8c95c20af3228aa514a47d",
"md5": "8f8c1fc763abd89a72c6dc8f4c971a03",
"sha256": "2521a0d33ab90ca86289ffc42fc55f7d8e61ea9df0925d23f6478f2d805b6128"
},
"downloads": -1,
"filename": "purviewcli-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f8c1fc763abd89a72c6dc8f4c971a03",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27101,
"upload_time": "2023-11-12T17:15:37",
"upload_time_iso_8601": "2023-11-12T17:15:37.928095Z",
"url": "https://files.pythonhosted.org/packages/93/7b/b6528573b5709e657873dd140fe08ed0e78c9f8c95c20af3228aa514a47d/purviewcli-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "178ba4c922aea36e9962ad35c41fa4929a481bb52475b594d133362af859f020",
"md5": "8a5a79a1d0e7be3714ec7f5f4c1f00f8",
"sha256": "f21bfe1d7a526031fb9407de91dca831e0718ac46ec832ccf49a0dc61f025e35"
},
"downloads": -1,
"filename": "purviewcli-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "8a5a79a1d0e7be3714ec7f5f4c1f00f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18900,
"upload_time": "2023-11-12T17:15:39",
"upload_time_iso_8601": "2023-11-12T17:15:39.601225Z",
"url": "https://files.pythonhosted.org/packages/17/8b/a4c922aea36e9962ad35c41fa4929a481bb52475b594d133362af859f020/purviewcli-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-12 17:15:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tayganr",
"github_project": "purviewcli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.25.1"
]
]
},
{
"name": "docopt",
"specs": [
[
"==",
"0.6.2"
]
]
},
{
"name": "azure-identity",
"specs": [
[
"==",
"1.5.0"
]
]
}
],
"lcname": "purviewcli"
}
JSON
