--- name: searchmanagementclient description: "SearchManagementClient API skill. Use when working with SearchManagementClient for providers, subscriptions. Covers 14 endpoints." version: 1.0.0 generator: lapsh --- # SearchManagementClient API version: 2015-08-19 ## Auth OAuth2 ## Base URL https://management.azure.com ## Setup 1. Configure auth: OAuth2 2. GET /providers/Microsoft.Search/operations -- lists all of the available rest api operations of the microsoft.search provider. 3. POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys -- create first listAdminKey ## Endpoints 14 endpoints across 2 groups. See references/api-spec.lap for full details. ### Providers | Method | Path | Description | |--------|------|-------------| | GET | /providers/Microsoft.Search/operations | Lists all of the available REST API operations of the Microsoft.Search provider. | ### Subscriptions | Method | Path | Description | |--------|------|-------------| | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys | Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service. | | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind} | Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time. | | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name} | Generates a new query key for the specified Search service. You can create up to 50 query keys per service. | | GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys | Returns the list of query API keys for the given Azure Cognitive Search service. | | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys | Returns the list of query API keys for the given Azure Cognitive Search service. | | DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key} | Deletes 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 it. | | PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Creates 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. | | PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Updates an existing Search service in the given resource group. | | GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Gets the Search service with the given name in the given resource group. | | DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Deletes a Search service in the given resource group, along with its associated resources. | | GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices | Gets a list of all Search services in the given resource group. | | GET | /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices | Gets a list of all Search services in the given subscription. | | POST | /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability | Checks 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 (https://.search.windows.net). | ## Common Questions Match user requests to endpoints in references/api-spec.lap. Key patterns: - "List all operations?" -> GET /providers/Microsoft.Search/operations - "Create a listAdminKey?" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys - "List all listQueryKeys?" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys - "Create a listQueryKey?" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys - "Delete a deleteQueryKey?" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key} - "Update a searchService?" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} - "Partially update a searchService?" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} - "Get searchService details?" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} - "Delete a searchService?" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} - "List all searchServices?" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices - "Create a checkNameAvailability?" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability - "How to authenticate?" -> See Auth section above ## Response Tips - Check response schemas in references/api-spec.lap for field details - Create/update endpoints return the modified resource on success - Error responses include status codes and descriptions in the spec ## References - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas > Generated from the official API spec by [LAP](https://lap.sh)