# Azure Search management API

> Azure Search management API on Apizie: 28 endpoints (Lists all of the available REST API operations of the Microsoft.Search provider., Checks whether or not the given search service name is available for use. Search service names must be…, Get a list of all Azure AI Search quota usages across the subscription., Gets the quota usage for a search SKU in the given subscription., …) 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-search/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

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

## Endpoints

### Lists all of the available REST API operations of the Microsoft.Search provider.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |

### Checks whether or not the given search service name is available for use. Search service names must be…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-check-name-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| body | object | yes | JSON request body |

### Get a list of all Azure AI Search quota usages across the subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/usages-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| location | string | yes | The name of the Azure region. |

### Gets the quota usage for a search SKU in the given subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/usage-by-subscription-sku` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| location | string | yes | The name of the Azure region. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| skuName | string | yes | The unique SKU name that identifies a billable tier. |

### Gets a list of all search services in the given subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets a list of all search services in the given resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets the search service with the given name in the given resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Creates or updates a search service in the given resource group. If the search service already exists, all…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| body | object | yes | JSON request body |

### Updates an existing search service in the given resource group.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| body | object | yes | JSON request body |

### Deletes a search service in the given resource group, along with its associated resources. Returns 200 (OK)…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Generates a new query key for the specified search service. You can create up to 50 query keys per service.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/query-keys-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| name | string | yes | The name of the new query API key. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/query-keys-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| key | string | yes | The query key to be deleted. Query keys are identified by value, not by name. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets the primary and secondary admin API keys for the specified Azure AI Search service.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/admin-keys-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Returns the list of query API keys for the given Azure AI Search service.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/query-keys-list-by-search-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets a list of network security perimeter configurations for a search service.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/network-security-perimeter-configurations-list-by-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |

### Gets a network security perimeter configuration.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/network-security-perimeter-configurations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| nspConfigName | string | yes | The network security perimeter configuration name. |

### Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/network-security-perimeter-configurations-reconcile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| nspConfigName | string | yes | The network security perimeter configuration name. |

### Gets a list of all private endpoint connections in the given service.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/private-endpoint-connections-list-by-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets the details of the private endpoint connection to the search service in the given resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/private-endpoint-connections-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection to the Azure AI Search service with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Updates a private endpoint connection to the search service in the given resource group.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/private-endpoint-connections-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection to the Azure AI Search service with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| body | object | yes | JSON request body |

### Disconnects the private endpoint connection and deletes it from the search service. Returns 200 (OK) with…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/private-endpoint-connections-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection to the Azure AI Search service with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets a list of all supported private link resource types for the given service.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/private-link-resources-list-supported` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/admin-keys-regenerate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| keyKind | string | yes | Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets a list of all shared private link resources managed by the given service.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/shared-private-link-resources-list-by-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Gets the details of the shared private link resource managed by the search service in the given resource…
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-search/shared-private-link-resources-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| sharedPrivateLinkResourceName | string | yes | The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Initiates the creation or update of a shared private link resource managed by the search service in the…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/shared-private-link-resources-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| sharedPrivateLinkResourceName | string | yes | The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |
| body | object | yes | JSON request body |

### Initiates the deletion of the shared private link resource from the search service. Returns 202 (Accepted)…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/shared-private-link-resources-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |
| sharedPrivateLinkResourceName | string | yes | The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. |
| x-ms-client-request-id | string | no | A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track… |

### Upgrades the Azure AI Search service to the latest version available.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-search/services-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| searchServiceName | string | yes | The name of the Azure AI Search service associated with the specified resource group. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-arm-search/operations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

### Can AI agents use the Azure Search 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-search.

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