# Azure Purview management API

> Azure Purview management API on Apizie: 26 endpoints (Gets the accounts resources by resource group., Gets the accounts resources by subscription., Gets the account resource., Create or update an account resource, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:azure-arm-purview/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-purview`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-arm-purview
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-arm-purview/openapi.json

Azure Resource Manager API for Purview: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### Gets the accounts resources by resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| api-version | string | no | The api version to use. |
| $skipToken | string | no | The skip token. |

### Gets the accounts resources by subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| api-version | string | no | The api version to use. |
| $skipToken | string | no | The skip token. |

### Gets the account resource.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |

### Create or update an account resource
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Patches the account resource.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Deletes the account resource.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |

### Lists the keys asynchronous.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-list-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |

### Add the administrator for root collection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-add-root-collection-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Gets the default account information set for the scope.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/default-accounts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scopeTenantId | string | yes | The tenant ID. |
| scopeType | string | yes | The scope for the default account. |
| scope | string | no | The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. |
| api-version | string | no | The api version to use. |

### Sets the default account for the scope.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/default-accounts-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Removes the default account from the scope.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/default-accounts-remove` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scopeTenantId | string | yes | The tenant ID. |
| scopeType | string | yes | The scope for the default account. |
| scope | string | no | The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. |
| api-version | string | no | The api version to use. |

### Gets a list of features and their status for the account. Status of enabled features will be true. Status of…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/features-account-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Gets a list of features and their status for the location and subscription. Status of enabled features will…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/features-subscription-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| locations | string | yes | Location of feature. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Gets the kafka configuration.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/kafka-configurations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| kafkaConfigurationName | string | yes | Name of kafka configuration. |
| api-version | string | no | The api version to use. |

### Create or update the kafka configuration.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/kafka-configurations-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| kafkaConfigurationName | string | yes | The kafka configuration name. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Deletes the kafka configuration on the account.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/kafka-configurations-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| kafkaConfigurationName | string | yes | Name of kafka configuration. |
| api-version | string | no | The api version to use. |

### Gets the list of Kafka configurations for the account.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/kafka-configurations-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |
| $skipToken | string | no | The skip token. |

### Lists the available operations
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The api version to use. |

### Gets private endpoint connections.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/private-endpoint-connections-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |
| $skipToken | string | no | The skip token. |

### Gets private endpoint connection information.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/private-endpoint-connections-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| privateEndpointConnectionName | string | yes | Name of the private endpoint connection. |
| api-version | string | no | The api version to use. |

### Approves/Rejects private endpoint connection request.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/private-endpoint-connections-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| privateEndpointConnectionName | string | yes | Name of the private endpoint connection. |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Deletes private endpoint connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/private-endpoint-connections-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| privateEndpointConnectionName | string | yes | Name of the private endpoint connection. |
| api-version | string | no | The api version to use. |

### Gets a list of privately linkable resources for an account.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/private-link-resources-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| api-version | string | no | The api version to use. |

### Gets a privately linkable resources for an account with given group identifier.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/private-link-resources-get-by-group-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| resourceGroupName | string | yes | The resource group name. |
| accountName | string | yes | The name of the account. |
| groupId | string | yes | The group identifier. |
| api-version | string | no | The api version to use. |

### Checks the account name availability.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-check-name-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| api-version | string | no | The api version to use. |
| body | object | yes | JSON request body |

### Gets the Usage quota configuration.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/usages-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The subscription identifier |
| location | string | yes | The region. |
| api-version | string | no | The api version to use. |
| $filter | string | no |  |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-list-by-resource-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Purview management API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:azure-arm-purview/accounts-list-by-resource-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Purview management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Purview management itself also needs your own key from azure.com.

### Can AI agents use the Azure Purview management API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-purview.

### What is the status of the Azure Purview management API?
Needs your own provider key (bring your own key)