Azure AI Search
Client that can be used to manage Azure AI Search services and API keys.
AI & machine learning#openapi#cloud
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
Client that can be used to manage Azure AI Search services and API keys.
Endpoints 28
Usages
- GETUsages_ListBySubscription
/subscriptions/:subscriptionId/providers/Microsoft.Search/locations/:location/usagesGet a list of all Azure AI Search quota usages across the subscription. - GETUsageBySubscriptionSku
/subscriptions/:subscriptionId/providers/Microsoft.Search/locations/:location/usages/:skuNameGets the quota usage for a search SKU in the given subscription.
Operations
- GETOperations_List
/providers/Microsoft.Search/operationsLists all of the available REST API operations of the Microsoft.Search provider.
Services
- POSTServices_CheckNameAvailability
/subscriptions/:subscriptionId/providers/Microsoft.Search/checkNameAvailabilityChecks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI… - GETServices_ListBySubscription
/subscriptions/:subscriptionId/providers/Microsoft.Search/searchServicesGets a list of all search services in the given subscription. - GETServices_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServicesGets a list of all search services in the given resource group. - GETServices_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceNameGets the search service with the given name in the given resource group. - PUTServices_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceNameCreates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values. - DELETEServices_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceNameDeletes a search service in the given resource group, along with its associated resources. Returns 200 (OK) on successful deletion, or 204 (No Content) if the… - PATCHServices_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceNameUpdates an existing search service in the given resource group. - POSTServices_Upgrade
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/upgradeUpgrades the Azure AI Search service to the latest version available.
AdminKeys
- POSTAdminKeys_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/listAdminKeysGets the primary and secondary admin API keys for the specified Azure AI Search service. - POSTAdminKeys_Regenerate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/regenerateAdminKey/:keyKindRegenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
QueryKeys
- POSTQueryKeys_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/createQueryKey/:nameGenerates a new query key for the specified search service. You can create up to 50 query keys per service. - DELETEQueryKeys_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/deleteQueryKey/:keyDeletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate… - POSTQueryKeys_ListBySearchService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/listQueryKeysReturns the list of query API keys for the given Azure AI Search service.
PrivateLinkResources
- GETPrivateLinkResources_ListSupported
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/privateLinkResourcesGets a list of all supported private link resource types for the given service.
PrivateEndpointConnections
- GETPrivateEndpointConnections_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/privateEndpointConnectionsGets a list of all private endpoint connections in the given service. - GETPrivateEndpointConnections_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/privateEndpointConnections/:privateEndpointConnectionNameGets the details of the private endpoint connection to the search service in the given resource group. - PUTPrivateEndpointConnections_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/privateEndpointConnections/:privateEndpointConnectionNameUpdates a private endpoint connection to the search service in the given resource group. - DELETEPrivateEndpointConnections_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/privateEndpointConnections/:privateEndpointConnectionNameDisconnects the private endpoint connection and deletes it from the search service. Returns 200 (OK) with the deleted connection details on successful…
SharedPrivateLinkResources
- GETSharedPrivateLinkResources_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/sharedPrivateLinkResourcesGets a list of all shared private link resources managed by the given service. - GETSharedPrivateLinkResources_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameGets the details of the shared private link resource managed by the search service in the given resource group. - PUTSharedPrivateLinkResources_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameInitiates the creation or update of a shared private link resource managed by the search service in the given resource group. - DELETESharedPrivateLinkResources_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameInitiates the deletion of the shared private link resource from the search service. Returns 202 (Accepted) for asynchronous deletion, 204 (No Content) if the…
NetworkSecurityPerimeterConfigurations
- GETNetworkSecurityPerimeterConfigurations_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/networkSecurityPerimeterConfigurationsGets a list of network security perimeter configurations for a search service. - GETNetworkSecurityPerimeterConfigurations_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/networkSecurityPerimeterConfigurations/:nspConfigNameGets a network security perimeter configuration. - POSTNetworkSecurityPerimeterConfigurations_Reconcile
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Search/searchServices/:searchServiceName/networkSecurityPerimeterConfigurations/:nspConfigName/reconcileReconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter…
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 28 operations on 21 pathsGET 13POST 7DELETE 4PUT 3PATCH 1
- Main resources
- Services 8PrivateEndpointConnections 4SharedPrivateLinkResources 4NetworkSecurityPerimeterConfigurations 3QueryKeys 3AdminKeys 2Usages 2Operations 1PrivateLinkResources 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2026-11-01 - Links
- OpenAPI document
How to test the Azure AI Search in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Search collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Usages_ListBySubscription” (GET /subscriptions/:subscriptionId/providers/Microsoft.Search/locations/:location/usages), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure AI Search?
Client that can be used to manage Azure AI Search services and API keys. It is listed under AI & machine learning and has 28 endpoints.
Who publishes the Azure AI Search?
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 AI Search?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure AI Search?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure AI Search have?
28 operations on 21 paths (13 GET, 7 POST, 4 DELETE, 3 PUT, 1 PATCH). The largest groups are Services, PrivateEndpointConnections, SharedPrivateLinkResources, NetworkSecurityPerimeterConfigurations.
Is forking the Azure AI Search free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.