Microsoft Azure

Azure Purview: Scanning Service

Creates a Microsoft.Scanning management client.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Creates a Microsoft.Scanning management client.

Endpoints 58

AzureKeyVaults

  • GETKeyVaultConnections_Get/azureKeyVaults/:azureKeyVaultName?api-version=stringGets an Azure Key Vault connection.
  • PUTKeyVaultConnections_CreateOrReplace/azureKeyVaults/:azureKeyVaultName?api-version=stringCreates or replaces a connection to Azure Key Vault.
  • DELETEKeyVaultConnections_Delete/azureKeyVaults/:azureKeyVaultName?api-version=stringDeletes an Azure Key Vault connection associated with the account.
  • GETKeyVaultConnections_List/azureKeyVaults?api-version=stringLists Azure Key Vaults in an account.

ClassificationRules

  • GETClassificationRules_Get/classificationrules/:classificationRuleName?api-version=stringGets a classification rule.
  • PUTClassificationRules_CreateOrReplace/classificationrules/:classificationRuleName?api-version=stringCreates or replaces a classification rule.
  • DELETEClassificationRules_Delete/classificationrules/:classificationRuleName?api-version=stringDeletes a classification rule.
  • GETClassificationRules_List/classificationrules?api-version=stringLists classification rules in Account.
  • GETClassificationRules_ListVersionsByRuleName/classificationrules/:classificationRuleName/versions?api-version=stringLists the rule versions of a classification rule.
  • POSTClassificationRules_TagClassificationVersion/classificationrules/:classificationRuleName/versions/:classificationRuleVersion:tag?action=Keep&api-version=stringSets classification action on a specific classification rule version.

Credential

  • GETCredential_Get/credentials/:credentialName?api-version=stringGets credential information.
  • PUTCredential_CreateOrReplace/credentials/:credentialName?api-version=stringCreates or replaces an instance of a credential.
  • DELETECredential_Delete/credentials/:credentialName?api-version=stringDeletes a credential associated with the account.
  • GETCredential_List/credentials?api-version=stringLists credentials in account.

DataSources

  • GETDataSources_Get/datasources/:dataSourceName?api-version=stringGets a data source.
  • PUTDataSources_CreateOrReplace/datasources/:dataSourceName?api-version=stringCreates or replaces a data source.
  • DELETEDataSources_Delete/datasources/:dataSourceName?api-version=stringDeletes a data source.
  • GETDataSources_List/datasources?api-version=stringLists data sources in Data catalog.

Filters

  • GETFilters_Get/datasources/:dataSourceName/scans/:scanName/filters/custom?api-version=stringGets a filter.
  • PUTFilters_CreateOrReplace/datasources/:dataSourceName/scans/:scanName/filters/custom?api-version=stringCreates or replaces a filter.

IntegrationRuntimes

  • GETIntegrationRuntimes_ListByAccount/integrationruntimes?api-version=stringLists integration runtimes in an account.
  • GETIntegrationRuntimes_Get/integrationruntimes/:integrationRuntimeName?api-version=stringGets an integration runtime.
  • PUTIntegrationRuntimes_CreateOrReplace/integrationruntimes/:integrationRuntimeName?api-version=stringCreates or replaces an instance of integration runtime.
  • DELETEIntegrationRuntimes_Delete/integrationruntimes/:integrationRuntimeName?api-version=stringDeletes an integration runtime.
  • GETIntegrationRuntimes_Status/integrationruntimes/:integrationRuntimeName/status?api-version=stringGets detailed status information for an integration runtime.
  • POSTIntegrationRuntimes_ListAuthKeys/integrationruntimes/:integrationRuntimeName:listAuthKeys?api-version=stringRetrieves the authentication keys for an integration runtime.
  • POSTIntegrationRuntimes_RegenerateAuthKey/integrationruntimes/:integrationRuntimeName:regenerateAuthKey?api-version=stringRegenerates the authentication key for an integration runtime.
  • POSTIntegrationRuntimes_DisableInteractiveQuery/integrationruntimes/:integrationRuntimeName:disableInteractiveQuery?api-version=stringDisables interactive querying.
  • POSTIntegrationRuntimes_EnableInteractiveQuery/integrationruntimes/:integrationRuntimeName:enableInteractiveQuery?api-version=stringEnables interactive querying.

ManagedVirtualNetworks

  • GETManagedVirtualNetworks_ListByAccount/managedvirtualnetworks?api-version=stringLists managed virtual networks in an account.
  • GETManagedVirtualNetworks_Get/managedvirtualnetworks/:managedVirtualNetworkName?api-version=stringGets a managed virtual network.
  • PUTManagedVirtualNetworks_CreateOrReplace/managedvirtualnetworks/:managedVirtualNetworkName?api-version=stringCreates or replaces a managed virtual network.

ManagedPrivateEndpoints

  • GETManagedPrivateEndpoints_ListByAccount/managedvirtualnetworks/:managedVirtualNetworkName/managedprivateendpoints?api-version=stringLists managed private endpoints under a managed virtual network.
  • GETManagedPrivateEndpoints_Get/managedvirtualnetworks/:managedVirtualNetworkName/managedprivateendpoints/:managedPrivateEndpointName?api-version=stringGets a managed private endpoint.
  • PUTManagedPrivateEndpoints_CreateOrReplace/managedvirtualnetworks/:managedVirtualNetworkName/managedprivateendpoints/:managedPrivateEndpointName?api-version=stringCreates or replaces a managed private endpoint.
  • DELETEManagedPrivateEndpoints_Delete/managedvirtualnetworks/:managedVirtualNetworkName/managedprivateendpoints/:managedPrivateEndpointName?api-version=stringDeletes a managed private endpoint.

Scan

  • GETScans_Get/datasources/:dataSourceName/scans/:scanName?api-version=stringGets a scan information.
  • PUTScans_CreateOrReplace/datasources/:dataSourceName/scans/:scanName?api-version=stringCreates or replaces an instance of a scan.
  • DELETEScans_Delete/datasources/:dataSourceName/scans/:scanName?api-version=stringDeletes the scan associated with the data source.
  • GETScans_ListByDataSource/datasources/:dataSourceName/scans?api-version=stringLists scans in data source.

ScanResult

  • GETScanResult_GetScanStatus/datasources/:dataSourceName/scans/:scanName/runs/:runId?api-version=stringGets the status of the scan run with ingestion details.
  • POSTScanResult_RunScan/datasources/:dataSourceName/scans/:scanName:run?runId=string&scanLevel=Incremental&api-version=stringRuns the scan
  • POSTScanResult_CancelScan/datasources/:dataSourceName/scans/:scanName/runs/:runId:cancel?api-version=stringCancels a scan.
  • GETScanResult_ListScanHistory/datasources/:dataSourceName/scans/:scanName/runs?api-version=stringLists the scan history of a scan.

ScanRulesets

  • GETScanRulesets_Get/scanrulesets/:scanRulesetName?api-version=stringGets a scan ruleset.
  • PUTScanRulesets_CreateOrReplace/scanrulesets/:scanRulesetName?api-version=stringCreates or replaces a scan ruleset.
  • DELETEScanRulesets_Delete/scanrulesets/:scanRulesetName?api-version=stringDeletes a scan ruleset.
  • GETScanRulesets_List/scanrulesets?api-version=stringLists scan rulesets in data catalog.

SystemScanRulesets

  • GETSystemScanRulesets_List/systemScanRulesets?api-version=stringLists all system scan rulesets for an account.
  • GETSystemScanRulesets_Get/systemScanRulesets/datasources/:dataSourceType?api-version=stringGets a system scan ruleset for a data source.
  • GETSystemScanRulesets_GetByVersion/systemScanRulesets/versions/:version?dataSourceType=None&api-version=stringGets a scan ruleset by version.
  • GETSystemScanRulesets_GetLatest/systemScanRulesets/versions/latest?dataSourceType=None&api-version=stringGets the latest version of a system scan ruleset.
  • GETSystemScanRulesets_ListVersionsByDataSource/systemScanRulesets/versions?dataSourceType=None&api-version=stringLists system scan ruleset versions in data catalog.

Triggers

  • GETTriggers_Get/datasources/:dataSourceName/scans/:scanName/triggers/default?api-version=stringGets trigger information.
  • PUTTriggers_CreateOrReplace/datasources/:dataSourceName/scans/:scanName/triggers/default?api-version=stringCreates or replaces an instance of a trigger.
  • DELETETriggers_Delete/datasources/:dataSourceName/scans/:scanName/triggers/default?api-version=stringDeletes the trigger associated with the scan.
  • POSTTriggers_Enable/datasources/:dataSourceName/scans/:scanName/triggers/default:enable?api-version=stringEnables a trigger.
  • POSTTriggers_Disable/datasources/:dataSourceName/scans/:scanName/triggers/default:disable?api-version=stringDisables a trigger.

API details

Base URL
https://purview.azure.com/scan
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
58 operations on 38 pathsGET 29PUT 11POST 9DELETE 9
Main resources
IntegrationRuntimes 9ClassificationRules 6SystemScanRulesets 5Triggers 5AzureKeyVaults 4Credential 4DataSources 4ManagedPrivateEndpoints 4Scan 4ScanResult 4
Response formats
application/json
Description format
Swagger 2.0, API version 2023-09-01

How to test the Azure Purview: Scanning Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Purview: Scanning Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “KeyVaultConnections_Get” (GET /azureKeyVaults/:azureKeyVaultName?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Purview: Scanning Service?

Creates a Microsoft.Scanning management client. It is listed under Developer tools and has 58 endpoints.

Who publishes the Azure Purview: Scanning Service?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Purview: Scanning Service?

Requests go to https://purview.azure.com/scan. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Purview: Scanning Service?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Purview: Scanning Service have?

58 operations on 38 paths (29 GET, 11 PUT, 9 POST, 9 DELETE). The largest groups are IntegrationRuntimes, ClassificationRules, SystemScanRulesets, Triggers.

Is forking the Azure Purview: Scanning Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.