Microsoft.Search (stable:2015-02-28)

2025/12/05 • 5 new, 5 deleted methods

AdminKeys_List (new)
Description :  Returns the primary and secondary API keys for the given Azure Search service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listAdminKeys
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service for which to list admin keys. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary API key of the Search service. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary API key of the Search service. ,
Required: False ,
}
string ,
}
QueryKeys_List (new)
Description :  Returns the list of query API keys for the given Azure Search service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listQueryKeys
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service for which to list query keys. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The query keys for the Azure Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the query API key; may be empty. ,
Required: False ,
}
string ,
key:
{
Description: The value of the query API key. ,
Required: False ,
}
string ,
}
,
]
,
}
Services_CreateOrUpdate (new)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties to set or update on the Search service. ,
Required: True ,
}
{
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource Id of the Azure Search service. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Search service. ,
Required: False ,
}
string ,
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
status:
{
Description: The status of the Search service. ,
Enum:
{
running: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the Search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the last provisioning operation performed on the Search service. ,
Enum:
{
succeeded: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource Id of the Azure Search service. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Search service. ,
Required: False ,
}
string ,
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
status:
{
Description: The status of the Search service. ,
Enum:
{
running: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the Search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the last provisioning operation performed on the Search service. ,
Enum:
{
succeeded: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
Services_Delete (new)
Description :  Deletes a Search service in the given resource group, along with its associated resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (204)

{}
Services_List (new)
Description :  Returns a list of all Search services in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Search services in the resource group. ,
Required: False ,
}
[
{
id:
{
Description: The resource Id of the Azure Search service. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Search service. ,
Required: False ,
}
string ,
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
status:
{
Description: The status of the Search service. ,
Enum:
{
running: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the Search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the last provisioning operation performed on the Search service. ,
Enum:
{
succeeded: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
AdminKeys_List (removed)
Description :  Returns the primary and secondary API keys for the given Azure Search service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listAdminKeys
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service for which to list admin keys. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary API key of the Search service. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary API key of the Search service. ,
Required: False ,
}
string ,
}
QueryKeys_List (removed)
Description :  Returns the list of query API keys for the given Azure Search service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listQueryKeys
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service for which to list query keys. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The query keys for the Azure Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the query API key; may be empty. ,
Required: False ,
}
string ,
key:
{
Description: The value of the query API key. ,
Required: False ,
}
string ,
}
,
]
,
}
Services_CreateOrUpdate (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties to set or update on the Search service. ,
Required: True ,
}
{
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource Id of the Azure Search service. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Search service. ,
Required: False ,
}
string ,
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
status:
{
Description: The status of the Search service. ,
Enum:
{
running: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the Search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the last provisioning operation performed on the Search service. ,
Enum:
{
succeeded: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource Id of the Azure Search service. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Search service. ,
Required: False ,
}
string ,
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
status:
{
Description: The status of the Search service. ,
Enum:
{
running: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the Search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the last provisioning operation performed on the Search service. ,
Enum:
{
succeeded: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
Services_Delete (removed)
Description :  Deletes a Search service in the given resource group, along with its associated resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the Search service to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (204)

{}
Services_List (removed)
Description :  Returns a list of all Search services in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Search services in the resource group. ,
Required: False ,
}
[
{
id:
{
Description: The resource Id of the Azure Search service. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Search service. ,
Required: False ,
}
string ,
location:
{
Description: The geographic location of the Search service. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the Search service in the Azure Portal. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Search service. ,
Required: False ,
}
{
status:
{
Description: The status of the Search service. ,
Enum:
{
running: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the Search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the last provisioning operation performed on the Search service. ,
Enum:
{
succeeded: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU of the Search Service, which determines price tier and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the Search service. ,
Enum:
{
free: No description available. ,
standard: No description available. ,
standard2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicaCount:
{
Description: The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}