Metadata-Version: 2.1
Name: purviewcli
Version: 0.0.4
Summary: This package provides a command line interface to Azure Purview's REST API.
Home-page: https://github.com/tayganr/purviewcli
Author: Taygan Rifat
Author-email: contact@taygan.co
License: MIT
Description: # Azure Purview CLI
        This package provides a command line interface to Azure Purview's REST API.  
        ![purviewcli](https://raw.githubusercontent.com/tayganr/purviewcli/master/doc/image/purviewcli_example.png)
        
        ## Pre-Requisites
        1. An [Azure Purview](https://docs.microsoft.com/en-us/azure/purview/create-catalog-portal) account.
        2. A [Service Principal](https://docs.microsoft.com/en-us/azure/purview/tutorial-using-rest-apis#create-a-service-principal-application) (Azure AD application). 
        3. Grant Service Principal [role assignment](https://docs.microsoft.com/en-us/azure/purview/tutorial-using-rest-apis#configure-your-catalog-to-trust-the-service-principal-application) *(Azure Purview > Access Control (IAM) > Add role assignment)*.
            * Purview Data Curator
            * Purview Data Source Administrator
        
        ## Installation
        ```
        pip install purviewcli
        ```
        
        ## Configuration
        You will need the following to initialise the configuration file:
        * Client ID *(aka Application ID)*
        * Client Secret
        * Tenant ID *(aka Directory ID)*
        * Azure Purview Account Name
        
        To initiate the configuration, execute the following command.
        ```
        pv config
        ```
        ![config](https://raw.githubusercontent.com/tayganr/purviewcli/master/doc/image/purviewcli_config.png)
        
        ## Usage
        ```
        pv command (mandatory parameters) [optional parameters]
        ```
        
        ## Commands
        ### Search
        ```
        search (--keywords=<keywords>) [--limit=<limit> --offset=<offset>]
        ```
        ### Entity
        ```
        getEntityAudit (--guid=<guid>) [--auditAction=<auditAction> --count=<count> --startKey=<startKey>]
        getEntityBulk (--guid=<guid>...) [--ignoreRelationships --minExtInfo]
        getEntityBulkHeaders [--tagUpdateStartTime=<tagUpdateStartTime>]
        getEntityBulkUniqueAttributeType (--typeName=<typeName>) [--ignoreRelationships --minExtInfo]
        getEntityBusinessmetadataImportTemplate
        getEntityGuid (--guid=<guid>) [--ignoreRelationships --minExtInfo]
        getEntityGuidClassification (--guid=<guid> --classificationName=<classificationName>)
        getEntityGuidClassifications (--guid=<guid>)
        getEntityGuidHeader (--guid=<guid>)
        getEntityUniqueAttributeType (--typeName=<typeName> --attrKey=<attrKey> --attrVal=<attrVal>) [--ignoreRelationships --minExtInfo]
        getEntityUniqueAttributeTypeHeader (--typeName=<typeName> --attrKey=<attrKey> --attrVal=<attrVal>)
        ```
        ### Glossary
        ```
        getGlossary [--glossaryGuid=<glossaryGuid>] [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryCategories (--glossaryGuid=<glossaryGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryCategoriesHeaders (--glossaryGuid=<glossaryGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryCategory (--categoryGuid=<categoryGuid>)
        getGlossaryCategoryRelated (--categoryGuid=<categoryGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryCategoryTerms (--categoryGuid=<categoryGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryDetailed (--glossaryGuid=<glossaryGuid>)
        getGlossaryTerm (--termGuid=<termGuid>)
        newGlossaryTerm (--termName=<termName> --termStatus=<termStatus>) [--termDescription=<termDescription> --termAcronym=<termAcronym> --synonym=<synonym>... --related=<related>...]
        getGlossaryTerms (--glossaryGuid=<glossaryGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryTermsAssignedEntities (--termGuid=<termGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryTermsHeaders (--glossaryGuid=<glossaryGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        getGlossaryTermsRelated (--termGuid=<termGuid>) [--limit=<limit> --offset=<offset> --sort=<sort>]
        ```
        ### Lineage
        ```
        getLineage (--guid=<guid>) [--depth=<depth> --width=<width> --direction=<direction> --forceNewApi --includeParent --getDerivedLineage]
        getLineageUniqueAttributeType (--typeName=<typeName>) [--depth=<depth> --direction=<direction>]
        ```
        ### Relationship
        ```
        getRelationshipGuid (--guid=<guid>) [--extendedInfo]
        ```
        ### Types
        ```
        getBusinessmetadatadef (--guid=<guid> | --name=<name>)
        getClassificationdef (--guid=<guid> | --name=<name>)
        getEntitydef (--guid=<guid> | --name=<name>)
        getEnumdef (--guid=<guid> | --name=<name>)
        getRelationshipdef (--guid=<guid> | --name=<name>)
        getStructdef (--guid=<guid> | --name=<name>)
        getTypedef (--guid=<guid> | --name=<name>)
        getTypedefs
        getTypedefsHeaders
        ```
        ### Scan
        ```
        getDatasources
        getDatasource (--datasource=<datasource>)
        getScans (--datasource=<datasource>)
        getScan (--datasource=<datasource> --scanName=<scanName>)
        getScanHistory (--datasource=<datasource> --scanName=<scanName>)
        getScanFilters (--datasource=<datasource> --scanName=<scanName>)
        runScan (--datasource=<datasource> --scanName=<scanName>) [--scanLevel=<scanLevel>]
        getSystemScanRulesets
        getSystemScanRulesetsSettings
        getScanRulesets
        ```
        ### Guardian (Insights)
        ```
        getAssetDistributionByDataSource [--registeredSourceGroup=<registeredSourceGroup> --classificationCategory=<classificationCategory> --classificationName=<classificationName>]
        getAssetDistributionByTopPaths (--datasource=<datasource>) [--registeredSourceGroup=<registeredSourceGroup> --classificationCategory=<classificationCategory> --classificationName=<classificationName>]
        getFileTypeSizeTimeSeries (--fileType=<fileType> --window=<window>) [--registeredSourceGroup=<registeredSourceGroup> --datasource=<datasource>]
        getFileTypeSizeTrendByDataSource (--fileType=<fileType> --window=<window>) [--registeredSourceGroup=<registeredSourceGroup> --datasource=<datasource>]
        getTopFileTypesBySize [--registeredSourceGroup=<registeredSourceGroup> --datasource=<datasource>]
        getTopLevelSummary [--registeredSourceGroup=<registeredSourceGroup>]
        getRegisteredSourceGroupsWithAssets
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
