Microsoft.Search searchServices 2019-10-01-preview

Article
12/09/2024

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@2019-10-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    hostingMode: 'string'
    networkRuleSet: {
      endpointAccess: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    replicaCount: int
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Identity

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' (required)

IpRule

Name	Description	Value
value	Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.	string

Microsoft.Search/searchServices

Name	Description	Value
identity	The identity of the resource.	Identity
location	The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.	string
name	The resource name	string (required)
properties	Properties of the Search service.	SearchServiceProperties
sku	The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

NetworkRuleSet

Name	Description	Value
endpointAccess	The level of access to the search service endpoint. Public, the search service endpoint is reachable from the internet. Private, the search service endpoint can only be accessed via private endpoints. Default is Public.	'Private' 'Public'
ipRules	A list of IP restriction rules that defines the inbound network access to the search service endpoint. These restriction rules are applied only when the EndpointAccess of the search service is Public.	IpRule[]

ResourceTags

Name	Description	Value

SearchServiceProperties

Name	Description	Value
hostingMode	Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.	'default' 'highDensity'
networkRuleSet	Network specific rules that determine how the Azure Cognitive Search service may be reached.	NetworkRuleSet
partitionCount	The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.	int Constraints: Min value = 1 Max value = 12
replicaCount	The number of replicas in the Search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.	int Constraints: Min value = 1 Max value = 12

Sku

Name	Description	Value
name	The SKU of the Search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Azure AI Studio Network Restricted	This set of templates demonstrates how to set up Azure AI Studio 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

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": "2019-10-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "hostingMode": "string",
    "networkRuleSet": {
      "endpointAccess": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "replicaCount": "int"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Identity

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' (required)

IpRule

Name	Description	Value
value	Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.	string

Microsoft.Search/searchServices

Name	Description	Value
apiVersion	The api version	'2019-10-01-preview'
identity	The identity of the resource.	Identity
location	The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.	string
name	The resource name	string (required)
properties	Properties of the Search service.	SearchServiceProperties
sku	The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Search/searchServices'

NetworkRuleSet

Name	Description	Value
endpointAccess	The level of access to the search service endpoint. Public, the search service endpoint is reachable from the internet. Private, the search service endpoint can only be accessed via private endpoints. Default is Public.	'Private' 'Public'
ipRules	A list of IP restriction rules that defines the inbound network access to the search service endpoint. These restriction rules are applied only when the EndpointAccess of the search service is Public.	IpRule[]

ResourceTags

Name	Description	Value

SearchServiceProperties

Name	Description	Value
hostingMode	Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.	'default' 'highDensity'
networkRuleSet	Network specific rules that determine how the Azure Cognitive Search service may be reached.	NetworkRuleSet
partitionCount	The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.	int Constraints: Min value = 1 Max value = 12
replicaCount	The number of replicas in the Search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.	int Constraints: Min value = 1 Max value = 12

Sku

Name	Description	Value
name	The SKU of the Search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure AI Studio Network Restricted	This set of templates demonstrates how to set up Azure AI Studio 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.
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@2019-10-01-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      hostingMode = "string"
      networkRuleSet = {
        endpointAccess = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      replicaCount = int
    }
  })
}

Property values

Identity

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' (required)

IpRule

Name	Description	Value
value	Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.	string

Microsoft.Search/searchServices

Name	Description	Value
identity	The identity of the resource.	Identity
location	The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.	string
name	The resource name	string (required)
properties	Properties of the Search service.	SearchServiceProperties
sku	The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Search/searchServices@2019-10-01-preview"

NetworkRuleSet

Name	Description	Value
endpointAccess	The level of access to the search service endpoint. Public, the search service endpoint is reachable from the internet. Private, the search service endpoint can only be accessed via private endpoints. Default is Public.	'Private' 'Public'
ipRules	A list of IP restriction rules that defines the inbound network access to the search service endpoint. These restriction rules are applied only when the EndpointAccess of the search service is Public.	IpRule[]

ResourceTags

Name	Description	Value

SearchServiceProperties

Name	Description	Value
hostingMode	Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.	'default' 'highDensity'
networkRuleSet	Network specific rules that determine how the Azure Cognitive Search service may be reached.	NetworkRuleSet
partitionCount	The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.	int Constraints: Min value = 1 Max value = 12
replicaCount	The number of replicas in the Search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.	int Constraints: Min value = 1 Max value = 12

Sku

Name	Description	Value
name	The SKU of the Search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

Share via

Microsoft.Search searchServices 2019-10-01-preview

Bicep resource definition

Resource format

Property values

Identity

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

ResourceTags

SearchServiceProperties

Sku

Quickstart samples

ARM template resource definition

Resource format

Property values

Identity

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

ResourceTags

SearchServiceProperties

Sku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

Identity

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

ResourceTags

SearchServiceProperties

Sku

Feedback

Additional resources