Microsoft Azure

Azure Purview

Creates a Microsoft.Purview 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.Purview management client.

Endpoints 26

Account

  • GETGets the accounts resources by resource group./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts?api-version=string&$skipToken=stringList accounts in ResourceGroup
  • GETGets the accounts resources by subscription./subscriptions/:subscriptionId/providers/Microsoft.Purview/accounts?api-version=string&$skipToken=stringList accounts in Subscription
  • GETGets the account resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName?api-version=stringGet an account
  • PUTCreate or update an account resource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName?api-version=stringCreates or updates an account
  • DELETEDeletes the account resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName?api-version=stringDeletes an account resource
  • PATCHPatches the account resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName?api-version=stringUpdates an account
  • POSTLists the keys asynchronous./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/listkeys?api-version=stringList the authorization keys associated with this account.
  • POSTAdd the administrator for root collection./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/addRootCollectionAdmin?api-version=stringAdd the administrator for root collection associated with this account.

DefaultAccount

  • GETGets the default account information set for the scope./providers/Microsoft.Purview/getDefaultAccount?scopeTenantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&scopeType=Tenant&scope=string&api-version=stringGet the default account for the scope.
  • POSTSets the default account for the scope./providers/Microsoft.Purview/setDefaultAccount?api-version=stringSets the default account for the scope.
  • POSTRemoves the default account from the scope./providers/Microsoft.Purview/removeDefaultAccount?scopeTenantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&scopeType=Tenant&scope=string&api-version=stringRemoves the default account from the scope.

Feature

  • POSTGets a list of features and their status for the account. Status of enabled features will be true. Status of disabled features will be false. Features that don't exist will be excluded from the results./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/listFeatures?api-version=stringGets details from a list of feature names.
  • POSTGets a list of features and their status for the location and subscription. Status of enabled features will be true. Status of disabled features will be false. Features that don't exist will be excluded from the results./subscriptions/:subscriptionId/providers/Microsoft.Purview/locations/:locations/listFeatures?api-version=stringGets details from a list of feature names.

KafkaConfiguration

  • GETGets the kafka configuration./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/kafkaConfigurations/:kafkaConfigurationName?api-version=stringGets the kafka configuration for the account
  • PUTCreate or update the kafka configuration./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/kafkaConfigurations/:kafkaConfigurationName?api-version=stringCreate or update Kafka Configuration
  • DELETEDeletes the kafka configuration on the account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/kafkaConfigurations/:kafkaConfigurationName?api-version=stringDeletes a KafkaConfiguration resource.
  • GETGets the list of Kafka configurations for the account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/kafkaConfigurations?api-version=string&$skipToken=stringLists the Kafka configurations in the Account

Operation

  • GETLists the available operations/providers/Microsoft.Purview/operations?api-version=stringList of available operations

PrivateEndpointConnection

  • GETGets private endpoint connections./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/privateEndpointConnections?api-version=string&$skipToken=stringGet private endpoint connections for account
  • GETGets private endpoint connection information./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringGet a private endpoint connection
  • PUTApproves/Rejects private endpoint connection request./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringCreate or update a private endpoint connection
  • DELETEDeletes private endpoint connection./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDelete a private endpoint connection

PrivateLinkResource

  • GETGets a list of privately linkable resources for an account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/privateLinkResources?api-version=stringGets a list of privately linkable resources for an account
  • GETGets a privately linkable resources for an account with given group identifier./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts/:accountName/privateLinkResources/:groupId?api-version=stringGets a privately linkable resources for an account with given group identifier

Provider

  • POSTChecks the account name availability./subscriptions/:subscriptionId/providers/Microsoft.Purview/checkNameAvailability?api-version=stringChecks if account name is available.

Usages

  • GETGets the Usage quota configuration./subscriptions/:subscriptionId/providers/Microsoft.Purview/locations/:location/usages?api-version=string&$filter=stringGet the usage quota configuration

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
26 operations on 19 pathsGET 12POST 7PUT 3DELETE 3PATCH 1
Main resources
Account 8KafkaConfiguration 4PrivateEndpointConnection 4DefaultAccount 3Feature 2PrivateLinkResource 2Operation 1Provider 1Usages 1
Response formats
application/json
Description format
Swagger 2.0, API version 2021-12-01

How to test the Azure Purview 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 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 “Gets the accounts resources by resource group.” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Purview/accounts?api-version=string&$skipToken=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?

Creates a Microsoft.Purview management client. It is listed under Developer tools and has 26 endpoints.

Who publishes the Azure Purview?

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?

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

How do I authenticate with the Azure Purview?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Purview have?

26 operations on 19 paths (12 GET, 7 POST, 3 PUT, 3 DELETE, 1 PATCH). The largest groups are Account, KafkaConfiguration, PrivateEndpointConnection, DefaultAccount.

Is forking the Azure Purview 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.