Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The searchServices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Search/searchServices@2015-02-28' = {
location: 'string'
name: 'string'
properties: {
partitionCount: int
replicaCount: int
sku: {
name: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Search/searchServices
| Name | Description | Value |
|---|---|---|
| location | The geographic location of the Search service. | string |
| name | The resource name | string (required) |
| properties | Properties of the Search service. | SearchServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
SearchServiceCreateOrUpdateParametersTags
| Name | Description | Value |
|---|
SearchServiceProperties
| Name | Description | Value |
|---|---|---|
| partitionCount | The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. | int |
| replicaCount | The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. | int |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. | Sku |
Sku
| Name | Description | Value |
|---|---|---|
| name | The SKU of the Search service. | 'free' 'standard' 'standard2' |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Search Service | AVM Resource Module for Search Service |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Azure AI Foundry Network Restricted | This set of templates demonstrates how to set up Azure AI Foundry with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure Cognitive Search service | This template creates an Azure Cognitive Search service |
| Network Secured Agent with User Managed Identity | This set of templates demonstrates how to set up Azure AI Agent Service with virtual network isolation using User Managed Identity authetication for the AI Service/AOAI connection and private network links to connect the agent to your secure data. |
| Standard Agent Setup | This set of templates demonstrates how to set up Azure AI Agent Service with the standard setup, meaning with managed identity authentication for project/hub connections and public internet access enabled. Agents use customer-owned, single-tenant search and storage resources. With this setup, you have full control and visibility over these resources, but you will incur costs based on your usage. |
ARM template resource definition
The searchServices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices resource, add the following JSON to your template.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2015-02-28",
"name": "string",
"location": "string",
"properties": {
"partitionCount": "int",
"replicaCount": "int",
"sku": {
"name": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Search/searchServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-02-28' |
| location | The geographic location of the Search service. | string |
| name | The resource name | string (required) |
| properties | Properties of the Search service. | SearchServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Search/searchServices' |
SearchServiceCreateOrUpdateParametersTags
| Name | Description | Value |
|---|
SearchServiceProperties
| Name | Description | Value |
|---|---|---|
| partitionCount | The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. | int |
| replicaCount | The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. | int |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. | Sku |
Sku
| Name | Description | Value |
|---|---|---|
| name | The SKU of the Search service. | 'free' 'standard' 'standard2' |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure AI Foundry Network Restricted |
This set of templates demonstrates how to set up Azure AI Foundry with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure Cognitive Search service |
This template creates an Azure Cognitive Search service |
| Azure Cognitive Search service with private endpoint |
This template creates an Azure Cognitive Search service with a private endpoint. |
| Network Secured Agent with User Managed Identity |
This set of templates demonstrates how to set up Azure AI Agent Service with virtual network isolation using User Managed Identity authetication for the AI Service/AOAI connection and private network links to connect the agent to your secure data. |
| Standard Agent Setup |
This set of templates demonstrates how to set up Azure AI Agent Service with the standard setup, meaning with managed identity authentication for project/hub connections and public internet access enabled. Agents use customer-owned, single-tenant search and storage resources. With this setup, you have full control and visibility over these resources, but you will incur costs based on your usage. |
| Web App with a SQL Database, Azure Cosmos DB, Azure Search |
This template provisions a Web App, a SQL Database, Azure Cosmos DB, Azure Search and Application Insights. |
Terraform (AzAPI provider) resource definition
The searchServices resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2015-02-28"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
partitionCount = int
replicaCount = int
sku = {
name = "string"
}
}
}
}
Property Values
Microsoft.Search/searchServices
| Name | Description | Value |
|---|---|---|
| location | The geographic location of the Search service. | string |
| name | The resource name | string (required) |
| properties | Properties of the Search service. | SearchServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Search/searchServices@2015-02-28" |
SearchServiceCreateOrUpdateParametersTags
| Name | Description | Value |
|---|
SearchServiceProperties
| Name | Description | Value |
|---|---|---|
| partitionCount | The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. | int |
| replicaCount | The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. | int |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. | Sku |
Sku
| Name | Description | Value |
|---|---|---|
| name | The SKU of the Search service. | 'free' 'standard' 'standard2' |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Search Service | AVM Resource Module for Search Service |