{"files":{"SKILL.md":"---\nname: searchmanagementclient\ndescription: \"SearchManagementClient API skill. Use when working with SearchManagementClient for providers, subscriptions. Covers 14 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# SearchManagementClient\nAPI version: 2015-08-19\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://management.azure.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /providers/Microsoft.Search/operations -- lists all of the available rest api operations of the microsoft.search provider.\n3. POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys -- create first listAdminKey\n\n## Endpoints\n14 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Providers\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /providers/Microsoft.Search/operations | Lists all of the available REST API operations of the Microsoft.Search provider. |\n\n### Subscriptions\n| Method | Path | Description |\n|--------|------|-------------|\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Updates an existing Search service in the given resource group. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Gets the Search service with the given name in the given resource group. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} | Deletes a Search service in the given resource group, along with its associated resources. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices | Gets a list of all Search services in the given resource group. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices | Gets a list of all Search services in the given subscription. |\n| 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). |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all operations?\" -> GET /providers/Microsoft.Search/operations\n- \"Create a listAdminKey?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys\n- \"List all listQueryKeys?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys\n- \"Create a listQueryKey?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys\n- \"Delete a deleteQueryKey?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}\n- \"Update a searchService?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n- \"Partially update a searchService?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n- \"Get searchService details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n- \"Delete a searchService?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n- \"List all searchServices?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices\n- \"Create a checkNameAvailability?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api SearchManagementClient\n@base https://management.azure.com\n@version 2015-08-19\n@auth OAuth2\n@common_fields {api-version: any # The API version to use for each request. The current version is 2015-08-19.}\n@endpoints 14\n@toc providers(1), subscriptions(13)\n\n@group providers\n@endpoint GET /providers/Microsoft.Search/operations\n@desc Lists all of the available REST API operations of the Microsoft.Search provider.\n@returns(200) Success. The response describes the list of operations.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys\n@desc Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your Search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}\n@desc Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., keyKind: any # Specifies which key to regenerate. Valid values include 'primary' and 'secondary'., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The specified admin key was successfully regenerated. Both admin keys are included in the response, including the newly-regenerated key.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}\n@desc Generates a new query key for the specified Search service. You can create up to 50 query keys per service.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., name: any # The name of the new query API key., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The query key was successfully created and is in the response. You can use the query key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys\n@desc Returns the list of query API keys for the given Azure Cognitive Search service.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) All query keys for the given Search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys\n@desc Returns the list of query API keys for the given Azure Cognitive Search service.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) All query keys for the given Search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on you Search indexes such as querying and looking up documents by ID.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}\n@desc 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.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., key: any # The query key to be deleted. Query keys are identified by value, not by name., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The query key was successfully deleted.\n@returns(204) The query key was successfully deleted.\n@errors {404: The subscription, resource group, Search service, or query key could not be found.}\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n@desc 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.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created., service: any # The definition of the Search service to create or update., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.\n@returns(201) If you requested creation of a free Search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n@desc Updates an existing Search service in the given resource group.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service to update., service: any # The definition of the Search service to update., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n@desc Gets the Search service with the given name in the given resource group.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The Search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}\n@desc Deletes a Search service in the given resource group, along with its associated resources.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., searchServiceName: any # The name of the Azure Cognitive Search service associated with the specified resource group., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The Search service was successfully deleted.\n@returns(204) The Search service was successfully deleted.\n@errors {404: The subscription, resource group, or Search service could not be found.}\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices\n@desc Gets a list of all Search services in the given resource group.\n@required {resourceGroupName: any # The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The operation succeeded. The response contains the list of all Search service definitions for the given resource group.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices\n@desc Gets a list of all Search services in the given subscription.\n@required {subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The operation succeeded. The response contains the list of all Search service definitions for the given subscription.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability\n@desc 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).\n@required {checkNameAvailabilityInput: map # The resource name and type to check., subscriptionId: any # The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.}\n@optional {x-ms-client-request-id: any # A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.}\n@returns(200) The name check completed. The response contains details of whether the name is valid and available. If the name is invalid, the response also contains a message explaining why not.\n\n@endgroup\n\n@end\n"}}