pvw-cli 1.2.8__py3-none-any.whl

purviewcli/cli/management.py

@@ -0,0 +1,141 @@
+"""
+usage: 
+    pvw management addRootCollectionAdmin --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --objectId=<val>
+    pvw management checkNameAvailability --subscriptionId=<val> --accountName=<val>
+    pvw management createAccount --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --payloadFile=<val>
+    pvw management defaultAccount --scopeTenantId=<val> --scopeType=<val> --scope=<val>
+    pvw management deleteAccount --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val>
+    pvw management deletePrivateEndpoint --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --privateEndpointConnectionName=<val>
+    pvw management listKeys --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val>
+    pvw management listOperations
+    pvw management listPrivateLinkResources --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> [--groupId=<val>]
+    pvw management putPrivateEndpoint --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --privateEndpointConnectionName=<val> --payloadFile=<val>
+    pvw management readAccount --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val>
+    pvw management readAccounts --subscriptionId=<val> [--resourceGroupName=<val>]
+    pvw management readPrivateEndpoint --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --privateEndpointConnectionName=<val>
+    pvw management readPrivateEndpoints --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val>
+    pvw management removeDefaultAccount --scopeTenantId=<val> --scopeType=<val> --scope=<val>
+    pvw management setDefaultAccount --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --scopeTenantId=<val> --scopeType=<val> --scope=<val>
+    pvw management updateAccount --subscriptionId=<val> --resourceGroupName=<val> --accountName=<val> --payloadFile=<val>
+
+options:
+    --subscriptionId=<val>                  [string]  The subscription ID.
+    --resourceGroupName=<val>               [string]  The name of the resource group.
+    --accountName=<val>                     [string]  The name of the account.
+    --scopeTenantId=<val>                   [string]  The scope tenant in which the default account is set.
+    --scopeType=<val>                       [string]  The scope where the default account is set (Tenant or Subscription).
+    --scope=<val>                           [string]  The scope object ID (e.g. sub ID or tenant ID).
+    --groupId=<val>                         [string]  The group identifier.
+    --privateEndpointConnectionName=<val>   [string]  The name of the private endpoint connection.
+    --objectId=<val>                        [string]  Gets or sets the object identifier of the admin.
+
+"""
+import click
+from purviewcli.client._management import Management
+
+@click.group()
+def management():
+    """
+    Manage metastore operations in Microsoft Purview.
+    """
+    pass
+
+def _invoke_management_method(method_name, **kwargs):
+    client = Management()
+    method = getattr(client, method_name)
+    args = {f'--{k}': v for k, v in kwargs.items() if v is not None}
+    try:
+        result = method(args)
+        click.echo(result)
+    except Exception as e:
+        click.echo(f"[ERROR] {e}", err=True)
+
+@management.command()
+def listoperations():
+    """List management operations"""
+    _invoke_management_method('managementListOperations')
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--accountName', required=True)
+def checknameavailability(subscriptionid, accountname):
+    """Check account name availability"""
+    _invoke_management_method('managementCheckNameAvailability', subscriptionId=subscriptionid, accountName=accountname)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=False)
+def readaccounts(subscriptionid, resourcegroupname):
+    """Read all accounts or by resource group"""
+    _invoke_management_method('managementReadAccounts', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=True)
+@click.option('--accountName', required=True)
+def readaccount(subscriptionid, resourcegroupname, accountname):
+    """Read a specific account"""
+    _invoke_management_method('managementReadAccount', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname, accountName=accountname)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=True)
+@click.option('--accountName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def createaccount(subscriptionid, resourcegroupname, accountname, payloadfile):
+    """Create a new account"""
+    _invoke_management_method('managementCreateAccount', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname, accountName=accountname, payloadFile=payloadfile)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=True)
+@click.option('--accountName', required=True)
+def deleteaccount(subscriptionid, resourcegroupname, accountname):
+    """Delete an account"""
+    _invoke_management_method('managementDeleteAccount', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname, accountName=accountname)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=True)
+@click.option('--accountName', required=True)
+def listkeys(subscriptionid, resourcegroupname, accountname):
+    """List account keys"""
+    _invoke_management_method('managementListKeys', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname, accountName=accountname)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=True)
+@click.option('--accountName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def updateaccount(subscriptionid, resourcegroupname, accountname, payloadfile):
+    """Update an account"""
+    _invoke_management_method('managementUpdateAccount', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname, accountName=accountname, payloadFile=payloadfile)
+
+@management.command()
+@click.option('--scopeTenantId', required=True)
+@click.option('--scopeType', required=True)
+@click.option('--scope', required=True)
+def defaultaccount(scopetenantid, scopetype, scope):
+    """Get the default account for a scope"""
+    _invoke_management_method('managementDefaultAccount', scopeTenantId=scopetenantid, scopeType=scopetype, scope=scope)
+
+@management.command()
+@click.option('--subscriptionId', required=True)
+@click.option('--resourceGroupName', required=True)
+@click.option('--accountName', required=True)
+@click.option('--scopeTenantId', required=True)
+@click.option('--scopeType', required=True)
+@click.option('--scope', required=True)
+def setdefaultaccount(subscriptionid, resourcegroupname, accountname, scopetenantid, scopetype, scope):
+    """Set the default account for a scope"""
+    _invoke_management_method('managementSetDefaultAccount', subscriptionId=subscriptionid, resourceGroupName=resourcegroupname, accountName=accountname, scopeTenantId=scopetenantid, scopeType=scopetype, scope=scope)
+
+@management.command()
+@click.option('--scopeTenantId', required=True)
+@click.option('--scopeType', required=True)
+@click.option('--scope', required=True)
+def removedefaultaccount(scopetenantid, scopetype, scope):
+    """Remove the default account for a scope"""
+    _invoke_management_method('managementRemoveDefaultAccount', scopeTenantId=scopetenantid, scopeType=scopetype, scope=scope)
+
+__all__ = ['management']

purviewcli/cli/policystore.py

@@ -0,0 +1,103 @@
+"""
+Manage policy store operations in Microsoft Purview using modular Click-based commands.
+
+Usage:
+  policystore delete-data-policy         Delete a data policy
+  policystore delete-data-policy-scope   Delete a data policy scope
+  policystore put-data-policy            Create or update a data policy
+  policystore put-data-policy-scope      Create or update a data policy scope
+  policystore put-metadata-policy        Create or update a metadata policy
+  policystore read-data-policies         Read data policies
+  policystore read-data-policy-scopes    Read data policy scopes
+  policystore read-metadata-policies     Read metadata policies
+  policystore read-metadata-policy       Read a metadata policy by collection or policyId
+  policystore read-metadata-roles        Read metadata roles
+  policystore --help                     Show this help message and exit
+
+Options:
+  -h --help                              Show this help message and exit
+"""
+import click
+from purviewcli.client._policystore import Policystore
+
+@click.group()
+def policystore():
+    """
+    Manage policy store operations in Microsoft Purview.
+    """
+    pass
+
+def _invoke_policystore_method(method_name, **kwargs):
+    client = Policystore()
+    method = getattr(client, method_name)
+    args = {f'--{k}': v for k, v in kwargs.items() if v is not None}
+    try:
+        result = method(args)
+        click.echo(result)
+    except Exception as e:
+        click.echo(f"[ERROR] {e}", err=True)
+
+@policystore.command(name='delete-data-policy')
+@click.option('--policyName', required=True)
+def delete_data_policy(policyname):
+    """Delete a data policy"""
+    _invoke_policystore_method('policystoreDeleteDataPolicy', policyName=policyname)
+
+@policystore.command(name='delete-data-policy-scope')
+@click.option('--policyName', required=True)
+@click.option('--datasource', required=True)
+def delete_data_policy_scope(policyname, datasource):
+    """Delete a data policy scope"""
+    _invoke_policystore_method('policystoreDeleteDataPolicyScope', policyName=policyname, datasource=datasource)
+
+@policystore.command(name='put-data-policy')
+@click.option('--policyName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def put_data_policy(policyname, payloadfile):
+    """Create or update a data policy"""
+    _invoke_policystore_method('policystorePutDataPolicy', policyName=policyname, payloadFile=payloadfile)
+
+@policystore.command(name='put-data-policy-scope')
+@click.option('--policyName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def put_data_policy_scope(policyname, payloadfile):
+    """Create or update a data policy scope"""
+    _invoke_policystore_method('policystorePutDataPolicyScope', policyName=policyname, payloadFile=payloadfile)
+
+@policystore.command(name='put-metadata-policy')
+@click.option('--policyId', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def put_metadata_policy(policyid, payloadfile):
+    """Create or update a metadata policy"""
+    _invoke_policystore_method('policystorePutMetadataPolicy', policyId=policyid, payloadFile=payloadfile)
+
+@policystore.command(name='read-data-policies')
+@click.option('--policyName', required=False)
+def read_data_policies(policyname):
+    """Read data policies"""
+    _invoke_policystore_method('policystoreReadDataPolicies', policyName=policyname)
+
+@policystore.command(name='read-data-policy-scopes')
+@click.option('--policyName', required=True)
+def read_data_policy_scopes(policyname):
+    """Read data policy scopes"""
+    _invoke_policystore_method('policystoreReadDataPolicyScopes', policyName=policyname)
+
+@policystore.command(name='read-metadata-policies')
+def read_metadata_policies():
+    """Read metadata policies"""
+    _invoke_policystore_method('policystoreReadMetadataPolicies')
+
+@policystore.command(name='read-metadata-policy')
+@click.option('--collectionName', required=False)
+@click.option('--policyId', required=False)
+def read_metadata_policy(collectionname, policyid):
+    """Read a metadata policy by collection or policyId"""
+    _invoke_policystore_method('policystoreReadMetadataPolicy', collectionName=collectionname, policyId=policyid)
+
+@policystore.command(name='read-metadata-roles')
+def read_metadata_roles():
+    """Read metadata roles"""
+    _invoke_policystore_method('policystoreReadMetadataRoles')
+
+__all__ = ['policystore']

purviewcli/cli/relationship.py

@@ -0,0 +1,75 @@
+"""
+usage: 
+    pvw relationship create --payloadFile=<val>
+    pvw relationship delete --guid=<val>
+    pvw relationship put --payloadFile=<val>
+    pvw relationship read --guid=<val> [--extendedInfo]
+
+options:
+    --purviewName=<val>           [string]  Microsoft Purview account name.
+    --extendedInfo                [boolean] Limits whether includes extended information [default: false].
+    --guid=<val>                  [string]  The globally unique identifier of the relationship.
+    --payloadFile=<val>           [string]  File path to a valid JSON document.
+
+"""
+import click
+import json
+from purviewcli.client._relationship import Relationship
+
+@click.group()
+def relationship():
+    """
+    Manage entity relationships in Microsoft Purview.
+    """
+    pass
+
+@relationship.command()
+@click.option('--payload-file', type=click.Path(exists=True), required=True, help='File path to a valid JSON document')
+def create(payload_file):
+    """Create a new relationship"""
+    try:
+        args = {'--payloadFile': payload_file}
+        client = Relationship()
+        result = client.relationshipCreate(args)
+        click.echo(json.dumps(result, indent=2))
+    except Exception as e:
+        click.echo(f"Error: {e}")
+
+@relationship.command()
+@click.option('--guid', required=True, help='The globally unique identifier of the relationship')
+def delete(guid):
+    """Delete a relationship by GUID"""
+    try:
+        args = {'--guid': guid}
+        client = Relationship()
+        result = client.relationshipDelete(args)
+        click.echo(json.dumps(result, indent=2))
+    except Exception as e:
+        click.echo(f"Error: {e}")
+
+@relationship.command()
+@click.option('--payload-file', type=click.Path(exists=True), required=True, help='File path to a valid JSON document')
+def put(payload_file):
+    """Update or create a relationship (PUT)"""
+    try:
+        args = {'--payloadFile': payload_file}
+        client = Relationship()
+        result = client.relationshipPut(args)
+        click.echo(json.dumps(result, indent=2))
+    except Exception as e:
+        click.echo(f"Error: {e}")
+
+@relationship.command()
+@click.option('--guid', required=True, help='The globally unique identifier of the relationship')
+@click.option('--extended-info', is_flag=True, default=False, help='Include extended information')
+def read(guid, extended_info):
+    """Read a relationship by GUID"""
+    try:
+        args = {'--guid': guid, '--extendedInfo': extended_info}
+        client = Relationship()
+        result = client.relationshipRead(args)
+        click.echo(json.dumps(result, indent=2))
+    except Exception as e:
+        click.echo(f"Error: {e}")
+
+__all__ = ['relationship']

purviewcli/cli/scan.py

@@ -0,0 +1,357 @@
+"""
+Manage scan operations in Microsoft Purview using modular Click-based commands.
+
+Usage:
+  scan cancel-scan                 Cancel a scan run
+  scan delete-classification-rule  Delete a classification rule
+  scan delete-credential           Delete a credential
+  scan delete-data-source          Delete a data source
+  scan delete-key-vault            Delete a key vault
+  scan delete-scan                 Delete a scan
+  scan delete-scan-ruleset         Delete a scan ruleset
+  scan delete-trigger              Delete a scan trigger
+  scan put-classification-rule     Create or update a classification rule
+  scan put-credential              Create or update a credential
+  scan put-data-source             Create or update a data source
+  scan put-filter                  Create or update a scan filter
+  scan put-key-vault               Create or update a key vault
+  scan put-scan                    Create or update a scan
+  scan put-scan-ruleset            Create or update a scan ruleset
+  scan put-trigger                 Create or update a scan trigger
+  scan read-classification-rule    Read a classification rule
+  scan read-classification-rules   Read classification rules
+  scan read-credential             Read a credential
+  scan read-data-source            Read a data source
+  scan read-data-sources           Read data sources
+  scan read-filters                Read scan filters
+  scan read-key-vault              Read a key vault
+  scan read-key-vaults             Read key vaults
+  scan read-scan                   Read a scan
+  scan read-scan-history           Read scan history
+  scan read-scan-ruleset           Read a scan ruleset
+  scan read-scan-rulesets          Read scan rulesets
+  scan read-scans                  Read scans
+  scan read-system-scan-ruleset    Read a system scan ruleset
+  scan run-scan                    Run a scan
+  scan tag-classification-version  Tag a classification version
+  scan --help                      Show this help message and exit
+
+Options:
+  -h --help                        Show this help message and exit
+"""
+# Scan CLI for Purview Data Map API (Atlas v2)
+"""
+CLI for managing scans, scan rulesets, triggers, and scan runs
+"""
+import click
+from purviewcli.client._scan import Scan
+
+@click.group()
+def scan():
+    """Manage scans and related resources"""
+    pass
+
+# Helper to invoke Scan methods
+def _invoke_scan_method(method_name, **kwargs):
+    scan_client = Scan()
+    method = getattr(scan_client, method_name)
+    args = {f'--{k}': v for k, v in kwargs.items() if v is not None}
+    try:
+        result = method(args)
+        click.echo(result)
+    except Exception as e:
+        click.echo(f"[ERROR] {e}", err=True)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+@click.option('--runId', required=True)
+def cancelscan(datasourcename, scanname, runid):
+    """Cancel a running scan"""
+    _invoke_scan_method('scanCancelScan', dataSourceName=datasourcename, scanName=scanname, runId=runid)
+
+@scan.command()
+@click.option('--classificationRuleName', required=True)
+def deleteclassificationrule(classificationrulename):
+    """Delete a classification rule"""
+    _invoke_scan_method('scanDeleteClassificationRule', classificationRuleName=classificationrulename)
+
+@scan.command()
+@click.option('--credentialName', required=True)
+def deletecredential(credentialname):
+    """Delete a credential"""
+    _invoke_scan_method('scanDeleteCredential', credentialName=credentialname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+def deletedatasource(datasourcename):
+    """Delete a data source"""
+    _invoke_scan_method('scanDeleteDataSource', dataSourceName=datasourcename)
+
+@scan.command()
+@click.option('--keyVaultName', required=True)
+def deletekeyvault(keyvaultname):
+    """Delete a key vault"""
+    _invoke_scan_method('scanDeleteKeyVault', keyVaultName=keyvaultname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+def deletescan(datasourcename, scanname):
+    """Delete a scan"""
+    _invoke_scan_method('scanDeleteScan', dataSourceName=datasourcename, scanName=scanname)
+
+@scan.command()
+@click.option('--scanRulesetName', required=True)
+def deletescanruleset(scanrulesetname):
+    """Delete a scan ruleset"""
+    _invoke_scan_method('scanDeleteScanRuleset', scanRulesetName=scanrulesetname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+def deletetrigger(datasourcename, scanname):
+    """Delete a scan trigger"""
+    _invoke_scan_method('scanDeleteTrigger', dataSourceName=datasourcename, scanName=scanname)
+
+@scan.command()
+@click.option('--classificationRuleName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putclassificationrule(classificationrulename, payloadfile):
+    """Create or update a classification rule"""
+    _invoke_scan_method('scanPutClassificationRule', classificationRuleName=classificationrulename, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--credentialName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putcredential(credentialname, payloadfile):
+    """Create or update a credential"""
+    _invoke_scan_method('scanPutCredential', credentialName=credentialname, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putdatasource(datasourcename, payloadfile):
+    """Create or update a data source"""
+    _invoke_scan_method('scanPutDataSource', dataSourceName=datasourcename, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putfilter(datasourcename, scanname, payloadfile):
+    """Create or update a scan filter"""
+    _invoke_scan_method('scanPutFilter', dataSourceName=datasourcename, scanName=scanname, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--keyVaultName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putkeyvault(keyvaultname, payloadfile):
+    """Create or update a key vault"""
+    _invoke_scan_method('scanPutKeyVault', keyVaultName=keyvaultname, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putscan(datasourcename, scanname, payloadfile):
+    """Create or update a scan"""
+    _invoke_scan_method('scanPutScan', dataSourceName=datasourcename, scanName=scanname, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--scanRulesetName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def putscanruleset(scanrulesetname, payloadfile):
+    """Create or update a scan ruleset"""
+    _invoke_scan_method('scanPutScanRuleset', scanRulesetName=scanrulesetname, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+@click.option('--payloadFile', required=True, type=click.Path(exists=True))
+def puttrigger(datasourcename, scanname, payloadfile):
+    """Create or update a scan trigger"""
+    _invoke_scan_method('scanPutTrigger', dataSourceName=datasourcename, scanName=scanname, payloadFile=payloadfile)
+
+@scan.command()
+@click.option('--classificationRuleName', required=True)
+def readclassificationrule(classificationrulename):
+    """Read a classification rule"""
+    _invoke_scan_method('scanReadClassificationRule', classificationRuleName=classificationrulename)
+
+@scan.command()
+@click.option('--classificationRuleName', required=True)
+def readclassificationruleversions(classificationrulename):
+    """Read classification rule versions"""
+    _invoke_scan_method('scanReadClassificationRuleVersions', classificationRuleName=classificationrulename)
+
+@scan.command()
+def readclassificationrules():
+    """Read all classification rules"""
+    _invoke_scan_method('scanReadClassificationRules')
+
+@scan.command()
+@click.option('--credentialName', required=False)
+def readcredential(credentialname):
+    """Read a credential or all credentials"""
+    _invoke_scan_method('scanReadCredential', credentialName=credentialname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+def readdatasource(datasourcename):
+    """Read a data source"""
+    _invoke_scan_method('scanReadDataSource', dataSourceName=datasourcename)
+
+@scan.command()
+@click.option('--collectionName', required=False)
+def readdatasources(collectionname):
+    """Read all data sources or by collection"""
+    _invoke_scan_method('scanReadDataSources', collectionName=collectionname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+def readfilters(datasourcename, scanname):
+    """Read scan filters"""
+    _invoke_scan_method('scanReadFilters', dataSourceName=datasourcename, scanName=scanname)
+
+@scan.command()
+@click.option('--keyVaultName', required=True)
+def readkeyvault(keyvaultname):
+    """Read a key vault"""
+    _invoke_scan_method('scanReadKeyVault', keyVaultName=keyvaultname)
+
+@scan.command()
+def readkeyvaults():
+    """Read all key vaults"""
+    _invoke_scan_method('scanReadKeyVaults')
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+def readscanhistory(datasourcename, scanname):
+    """Read scan history"""
+    _invoke_scan_method('scanReadScanHistory', dataSourceName=datasourcename, scanName=scanname)
+
+@scan.command()
+@click.option('--scanRulesetName', required=True)
+def readscanruleset(scanrulesetname):
+    """Read a scan ruleset"""
+    _invoke_scan_method('scanReadScanRuleset', scanRulesetName=scanrulesetname)
+
+@scan.command()
+def readscanrulesets():
+    """Read all scan rulesets"""
+    _invoke_scan_method('scanReadScanRulesets')
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+def readscan(datasourcename, scanname):
+    """Read a scan"""
+    _invoke_scan_method('scanReadScan', dataSourceName=datasourcename, scanName=scanname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+def readscans(datasourcename):
+    """Read all scans for a data source"""
+    _invoke_scan_method('scanReadScans', dataSourceName=datasourcename)
+
+@scan.command()
+@click.option('--dataSourceType', required=True)
+def readsystemscanruleset(datasourcetype):
+    """Read a system scan ruleset"""
+    _invoke_scan_method('scanReadSystemScanRuleset', dataSourceType=datasourcetype)
+
+@scan.command()
+@click.option('--dataSourceType', required=True)
+def readsystemscanrulesetlatest(datasourcetype):
+    """Read latest system scan ruleset"""
+    _invoke_scan_method('scanReadSystemScanRulesetLatest', dataSourceType=datasourcetype)
+
+@scan.command()
+@click.option('--version', required=True)
+@click.option('--dataSourceType', required=True)
+def readsystemscanrulesetversion(version, datasourcetype):
+    """Read a specific version of a system scan ruleset"""
+    _invoke_scan_method('scanReadSystemScanRulesetVersion', version=version, dataSourceType=datasourcetype)
+
+@scan.command()
+@click.option('--dataSourceType', required=True)
+def readsystemscanrulesetversions(datasourcetype):
+    """Read all versions of a system scan ruleset"""
+    _invoke_scan_method('scanReadSystemScanRulesetVersions', dataSourceType=datasourcetype)
+
+@scan.command()
+def readsystemscanrulesets():
+    """Read all system scan rulesets"""
+    _invoke_scan_method('scanReadSystemScanRulesets')
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+def readtrigger(datasourcename, scanname):
+    """Read a scan trigger"""
+    _invoke_scan_method('scanReadTrigger', dataSourceName=datasourcename, scanName=scanname)
+
+@scan.command()
+@click.option('--dataSourceName', required=True)
+@click.option('--scanName', required=True)
+@click.option('--scanLevel', required=False, default='Full')
+def runscan(datasourcename, scanname, scanlevel):
+    """Run a scan"""
+    _invoke_scan_method('scanRunScan', dataSourceName=datasourcename, scanName=scanname, scanLevel=scanlevel)
+
+@scan.command()
+@click.option('--classificationRuleName', required=True)
+@click.option('--classificationRuleVersion', required=True, type=int)
+@click.option('--action', required=True)
+def tagclassificationversion(classificationrulename, classificationruleversion, action):
+    """Tag a classification rule version"""
+    _invoke_scan_method('scanTagClassificationVersion', classificationRuleName=classificationrulename, classificationRuleVersion=classificationruleversion, action=action)
+
+@scan.command()
+def list():
+    """List all scans (TODO: add filtering options)"""
+    # TODO: Call Scan().scanReadScans()
+    pass
+
+@scan.command()
+def read():
+    """Read a scan by name"""
+    # TODO: Call Scan().scanReadScan()
+    pass
+
+@scan.command()
+def create():
+    """Create a new scan"""
+    # TODO: Call Scan().scanPutScan()
+    pass
+
+@scan.command()
+def update():
+    """Update an existing scan"""
+    # TODO: Call Scan().scanPutScan()
+    pass
+
+@scan.command()
+def delete():
+    """Delete a scan by name"""
+    # TODO: Call Scan().scanDeleteScan()
+    pass
+
+@scan.command()
+def run():
+    """Run a scan"""
+    # TODO: Call Scan().scanRunScan()
+    pass
+
+@scan.command()
+def cancel():
+    """Cancel a running scan"""
+    # TODO: Call Scan().scanCancelScan()
+    pass
+
+# TODO: Add commands for rulesets, triggers, scan history, etc.
+
+__all__ = ['scan']