SearchManagementClient

Name: SearchManagementClient API
Brand: SearchManagementClient
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureComputeoauth213 EndpointsREST

For Agents

Provision Azure Cognitive Search service resources, scale replicas and partitions, and manage admin and query keys at the ARM control plane.

Connect the SearchManagementClient to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the SearchManagementClient, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with SearchManagementClient API.

Create or delete a Cognitive Search service in a resource group

Update a search service's replica and partition counts to scale read or storage capacity

Regenerate primary or secondary admin keys to rotate credentials

Mint and revoke query keys scoped to specific applications

GET STARTED

Start building with SearchManagementClient API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for SearchManagementClient, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for SearchManagementClient, keeping it validated and agent-ready. The Azure Cognitive Search ARM control plane API provisions, scales, and manages search service resources inside a subscription. Agents can create or delete a search service, change its replica and partition counts, regenerate admin keys, mint or revoke query keys, and check name availability before creation. This is the lifecycle API behind any Cognitive Search deployment.

Use Cases

Patterns agents use SearchManagementClient API for, with concrete tasks.

★ Search Service Provisioning at Scale

Platform teams use SearchManagementClient to provision Cognitive Search services as part of an environment template. The PUT operation accepts SKU, replica count, partition count, and host mode, returning a long-running operation handle. Multiple services can be provisioned in parallel under the same subscription, each landing in its own resource group with its own admin and query keys.

PUT /subscriptions/{subscriptionId}/resourceGroups/{rg}/providers/Microsoft.Search/searchServices/{name} with sku=standard, replicaCount=2, partitionCount=1 and poll until provisioningState is Succeeded

Capacity Scaling for Read Throughput

When query volume rises, SREs scale a Cognitive Search service horizontally by increasing its replica count. The PATCH endpoint accepts the new replicaCount and partitionCount, and Azure handles the rebalance. Partitions scale storage; replicas scale query throughput. Both can be raised independently up to the SKU's ceiling.

PATCH the search service with replicaCount=4 to double the read throughput of the existing service

Key Rotation for Compliance

Security teams rotate Cognitive Search admin keys on a regular cadence. The regenerateAdminKey POST takes either primary or secondary as the key kind so callers can rotate one key while applications continue to use the other. Query keys can be created and revoked individually so per-application credentials never get reused across teams.

POST regenerateAdminKey with keyKind=primary on service mysearch and confirm the new key value is returned in the response

Agent-Driven Search Provisioning via Jentic

Through Jentic, a platform agent can search for provision azure cognitive search, load the search service PUT schema, populate it with SKU and capacity parameters, and execute the call with a managed Azure OAuth token. The same flow can mint query keys and pass them to the data plane SearchIndexClient operations, all without exposing raw secrets.

Search Jentic for provision azure cognitive search, load the search service PUT schema, execute it with sku=basic and replicaCount=1, then call createQueryKey to mint a key for the application

Key Endpoints

13 endpoints — jentic publishes the only available openapi specification for searchmanagementclient, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}

Create or update a search service

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}

Scale replicas or partitions

POST

/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability

Check service name availability

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys

List admin keys

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}

Regenerate an admin key

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}

Create a query key

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}

Create or update a search service

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}

Scale replicas or partitions

POST

/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability

Check service name availability

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys

List admin keys

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure service principal credentials are stored encrypted in the Jentic vault. Agents receive scoped OAuth tokens for the management.azure.com audience only — the underlying client secret never enters the agent context.

Intent-based discovery

Agents search by intent such as provision azure cognitive search or rotate search admin key, and Jentic returns the matching SearchManagementClient operation with its full input schema across service CRUD, scaling, and key management.

Time to first call

Direct integration: 1-2 days to wire MSAL, ARM long-running operation polling, and the key management endpoint shapes. Through Jentic: under an hour to search, load, and execute a service deployment.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Azure SearchIndexClient

Data plane API that queries and indexes documents in services this API provisions

Use after provisioning a service here to push documents and run queries against it

Complementary

Azure SearchServiceClient

Data plane API that defines the indexes and indexers running inside the service

Use after provisioning to define the index schema, indexers, and skillsets

Complementary

Azure ResourceManagementClient

Provisions the resource group and ARM context where the search service lives

Use first to create or select the resource group hosting the search service

Alternative

Algolia Search API

Hosted search-as-a-service alternative outside the Azure stack

Choose when the team prefers a fully managed search service not tied to Azure ARM lifecycle

FAQs

Specific to using SearchManagementClient API through Jentic.

Why is there no official OpenAPI spec for SearchManagementClient?

Microsoft Azure does not publish a unified OpenAPI specification for the Cognitive Search ARM control plane. Jentic generates and maintains this spec so that AI agents and developers can call SearchManagementClient via structured tooling. It is validated against the live Azure Resource Manager API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does SearchManagementClient use?

It uses Azure Active Directory OAuth 2.0 via the azure_auth flow. Acquire a bearer token for https://management.azure.com/.default and pass it as Authorization: Bearer. Note that this is the management plane; data plane calls to the SearchIndexClient use api-key headers instead.

Can I scale a search service after it is created?

Yes. PATCH to .../searchServices/{searchServiceName} with new replicaCount or partitionCount. Replicas scale read throughput, partitions scale storage and indexing throughput. Both are bounded by the SKU you provisioned.

How do I regenerate an admin key without downtime?

Each search service has primary and secondary admin keys. Switch your applications to use the secondary key, then POST regenerateAdminKey with keyKind=primary. Once applications confirm they are using the new primary, repeat for the secondary. This rotates both keys with zero downtime.

What are the rate limits for SearchManagementClient?

Calls count against Azure Resource Manager subscription throttling, roughly 12,000 reads and 1,200 writes per hour per subscription. Service creation and scale operations are long-running and complete asynchronously, so the throttle bucket only counts the initial PUT or PATCH call.

How do I provision a search service through Jentic?

Search Jentic for provision azure cognitive search, call client.load on the search service PUT operation to receive its input schema, then call client.execute with subscriptionId, resourceGroupName, searchServiceName, sku, and replica and partition counts. Jentic injects the OAuth token and returns the long-running operation handle.