Purviewcli

Data Share Support

Added support for Data Share - `Shares`, `Invitations`, `Mappings`, and `Assets`.

Refer to the [Command Reference](https://github.com/tayganr/purviewcli/blob/master/doc/commands/share/main.md) for usage details on the new commands.

Updated Default User Agent

New user agent includes `purviewcli/<version>` to indicate requests are sent using purviewcli. Thanks to sonnyhcl for submitting the PR.

See [pull request](https://github.com/tayganr/purviewcli/pull/20) for more details.

Apache Atlas 2.2 Support

Added support for Apache Atlas 2.2 features - Business Metadata, Business Attributes, Custom Attributes, and Labels.

Note: Microsoft Purview now supports Apache Atlas 2.2, see [blog post](https://docs.microsoft.com/en-us/azure/purview/tutorial-atlas-2-2-apis) for more details.

Business Metadata

- pv entity addOrUpdateBusinessMetadata
- pv entity deleteBusinessMetadata
- pv entity getBusinessMetadataTemplate
- pv entity importBusinessMetadata
- pv types readBusinessMetadataDef

Business Attributes

- pv entity addOrUpdateBusinessAttribute
- pv entity deleteBusinessAttribute

Custom Attributes

- pv entity create

Labels

- pv entity addLabels
- pv entity deleteLabels
- pv entity setLabels
- pv entity addLabelsByUniqueAttribute
- pv entity deleteLabelsByUniqueAttribute
- pv entity setLabelsByUniqueAttribute

Refer to the [Command Reference](https://github.com/tayganr/purviewcli#command-reference) for usage details on each command.

- **[Fix]** Ability to bulk import terms from a local CSV with support for hierarchal terms.

pv glossary createTermsImport --glossaryFile=<val> [--glossaryGuid=<val> --includeTermHierarchy]


Example usage for a glossary csv that includes hierarchal terms:

pv glossary createTermsImport --glossaryFile "C:\Users\tarifat\Downloads\glossary.csv" --includeTermHierarchy

IMPORTANT

There are breaking changes in this release. Please review the complete list of changes below and update existing scripts accordingly.

All Commands

- **[Change]** All commands that previously utilised the `--payload-file` or `--filter-file` parameters have been renamed to `--payloadFile` and `--filterFile` respectively. This change ensures consistency across all purviewcli parameters (camelCase).

Entity

- **[New]** Ability to create or update entities to a target collection.

pv entity changeCollection --collection=<val> --payloadFile=<val>
pv entity createOrUpdateCollection --collection=<val> --payloadFile=<val>
pv entity createOrUpdateCollectionBulk --collection=<val> --payloadFile=<val>


- **[Fixed]** Ability to perform CRUD operations on entities via a unique attribute (i.e. qualified name).

pv entity createUniqueAttributeClassifications --typeName=<val> --qualifiedName=<val> --payloadFile=<val>
pv entity deleteUniqueAttribute --typeName=<val> --qualifiedName=<val>
pv entity deleteUniqueAttributeClassification --typeName=<val> --qualifiedName=<val> --classificationName=<val>
pv entity putUniqueAttribute --typeName=<val> --qualifiedName=<val> --payloadFile=<val>
pv entity putUniqueAttributeClassifications --typeName=<val> --qualifiedName=<val> --payloadFile=<val>
pv entity readBulkUniqueAttribute --typeName=<val> --qualifiedName=<val>... [--ignoreRelationships --minExtInfo]


Glossary

- **[Fixed]** Ability to import terms via a local CSV file.

pv glossary createTermsImport --glossaryFile=<val> [--glossaryGuid=<val> --includeTermHierarchy]


- **[Enhanced]** Ability to read glossary properties without terms and categories.

pv glossary read [--glossaryGuid=<val> --limit=<val> --offset=<val> --sort=<val> --ignoreTermsAndCategories]


- **[Enhanced]** Added support for hierarchical glossary terms.

pv glossary createTerm --payloadFile=<val> [--includeTermHierarchy]
pv glossary createTerms --payloadFile=<val> [--includeTermHierarchy]
pv glossary createTermsExport --glossaryGuid=<val> --termGuid=<val>... [--includeTermHierarchy]
pv glossary createTermsImport --glossaryFile=<val> [--glossaryGuid=<val> --includeTermHierarchy]
pv glossary putPartial --glossaryGuid=<val> --payloadFile=<val> [--includeTermHierarchy]
pv glossary putTerm --termGuid=<val> --payloadFile=<val> [--includeTermHierarchy]
pv glossary putTermPartial --termGuid=<val> --payloadFile=<val> [--includeTermHierarchy]
pv glossary readDetailed --glossaryGuid=<val> [--includeTermHierarchy]
pv glossary readTerm --termGuid=<val> [--includeTermHierarchy]
pv glossary readTerms [--glossaryGuid=<val> --limit=<val> --offset=<val> --sort=<val> --extInfo --includeTermHierarchy]


Insight

- **[New]** Added support for new reports.

pv insight filesAggregation
pv insight tags
pv insight tagsTimeSeries


- **[Removed]** Removed support for deprecated reports.

pv insight assetDataSources
pv insight fileExtensions [--numberOfDays=<val> --takeTopCount=<val>]
pv insight fileTypeSizeTimeSeries [--numberOfDays=<val> --fileType=<val> --dataSource=<val>]
pv insight graphql --payloadFile=<val>
pv insight topFileTypesBySize


Policystore

- **[New]** Added support for data policies.

pv policystore deleteDataPolicy --policyName=<val>
pv policystore deleteDataPolicyScope --policyName=<val> --datasource=<val>
pv policystore putDataPolicy --policyName=<val> --payloadFile=<val>
pv policystore putDataPolicyScope --policyName=<val> --payloadFile=<val>
pv policystore readDataPolicies [--policyName=<val>]
pv policystore readDataPolicyScopes --policyName=<val>


Scan

- **[Change]** Moved credential commands under scan.

pv scan deleteCredential --credentialName=<val>
pv scan putCredential --credentialName=<val> --payloadFile=<val>
pv scan readCredential [--credentialName=<val>]


- **[Enhanced]** Added the ability to list data sources by collection name.

pv scan readDataSources [--collectionName=<val>]

- **[New]** Added CRUD support for collections. New commands can be found under `pv account`.