Microsoft.Search searchServices 2015-02-28
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
partitionCount: int
replicaCount: int
sku: {
name: 'string'
}
}
}
Property values
searchServices
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | The geographic location of the Search service. | string |
| tags | Tags to help categorize the Search service in the Azure Portal. | Dictionary of tag names and values. See Tags in templates |
| properties | Properties of the Search service. | SearchServiceProperties |
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' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
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. |
| 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. |
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",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"partitionCount": "int",
"replicaCount": "int",
"sku": {
"name": "string"
}
}
}
Property values
searchServices
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Search/searchServices' |
| apiVersion | The resource api version | '2015-02-28' |
| name | The resource name | string (required) |
| location | The geographic location of the Search service. | string |
| tags | Tags to help categorize the Search service in the Azure Portal. | Dictionary of tag names and values. See Tags in templates |
| properties | Properties of the Search service. | SearchServiceProperties |
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' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| 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. |
| 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. |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
partitionCount = int
replicaCount = int
sku = {
name = "string"
}
}
})
}
Property values
searchServices
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Search/searchServices@2015-02-28" |
| name | The resource name | string (required) |
| location | The geographic location of the Search service. | string |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Tags to help categorize the Search service in the Azure Portal. | Dictionary of tag names and values. |
| properties | Properties of the Search service. | SearchServiceProperties |
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" |