Aracılığıyla paylaş


Microsoft. Arama aramaHizmetler 2023-11-01

Bicep kaynak tanımı

searchServices kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft oluşturmak için. Arama/searchServices kaynağını şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    type: 'string'
  }
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any()
    }
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
  }
}

Özellik değerleri

searchServices

Ad Açıklama Değer
name Kaynak adı dize (gerekli)
location Kaynağın bulunduğu coğrafi konum dize (gerekli)
etiketler Kaynak etiketleri. Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler
Sku Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Bu özellik, yeni bir arama hizmeti oluştururken gereklidir. Sku
identity Kaynağın kimliği. Kimlik
properties Arama hizmetinin özellikleri. SearchServiceProperties

Kimlik

Ad Açıklama Değer
tür Kimlik türü. 'Yok'
'SystemAssigned' (gerekli)

SearchServiceProperties

Ad Açıklama Değer
authSeçenekler Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz. DataPlaneAuthOptions
disableLocalAuth true olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz. bool
encryptionWithCmk Bir arama hizmeti içindeki customer manager anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir. EncryptionWithCmk
hostingMode Yalnızca standart3 SKU için geçerlidir. Bu özelliği, diğer SKU'lar için izin verilen en fazla dizinden çok daha yüksek olan 1000'e kadar dizine izin veren 3'e kadar yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz. Standart3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır. 'varsayılan'
'highDensity'
networkRuleSet Arama hizmetine nasıl ulaşılabileceğini belirleyen ağa özgü kurallar. NetworkRuleSet
partitionCount Arama hizmetindeki bölüm sayısı; belirtilirse 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır. int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 12
publicNetworkAccess Mevcut müşteri kaynakları ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, genel arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olabilir. 'devre dışı'
'etkin'
replicaCount Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında bir değer veya temel SKU için 1 ile 3 arasında bir değer olmalıdır. int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 12
semantik Arama Anlamsal aramanın kullanılabilirliğini denetleyebilen seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür. 'devre dışı'
'ücretsiz'
'standart'

DataPlaneAuthOptions

Ad Açıklama Değer
aadOrApiKey Kimlik doğrulaması için API anahtarının veya Microsoft Entra ID kiracıdaki bir erişim belirtecinin kullanılabileceğini gösterir. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Kimlik doğrulaması için yalnızca API anahtarının kullanılabileceğini gösterir. Bicep için any() işlevini kullanabilirsiniz.

DataPlaneAadOrApiKeyAuthOption

Ad Açıklama Değer
aadAuthFailureMode Bir arama hizmetinin veri düzlemi API'sinin kimlik doğrulaması başarısız olan istekler için hangi yanıtı göndereceğini açıklar. 'http401WithBearerChallenge'
'http403'

EncryptionWithCmk

Ad Açıklama Değer
Zorlama Bir arama hizmetinin müşteri tarafından şifrelenmemiş bir veya daha fazla kaynağa sahip olmayı nasıl zorunlu kılması gerektiğini açıklar. 'Devre Dışı'
'Etkin'
'Belirtilmemiş'

NetworkRuleSet

Ad Açıklama Değer
ipRules IP güvenlik duvarı için kullanılan IP kısıtlama kurallarının listesi. Kurallarla eşleşmeyen IP'ler güvenlik duvarı tarafından engellenir. Bu kurallar yalnızca arama hizmetinin 'publicNetworkAccess' değeri 'etkin' olduğunda uygulanır. IpRule[]

IpRule

Ad Açıklama Değer
değer Tek bir IPv4 adresine (örneğin, 123.1.2.3) veya CIDR biçiminde bir IP aralığına (örneğin, 123.1.2.3/24) karşılık gelen değere izin verilir. string

Sku

Ad Açıklama Değer
name Arama hizmetinin SKU'su. Geçerli değerler şunlardır: 'free': Paylaşılan hizmet. 'basic': 3 çoğaltmaya kadar ayrılmış hizmet. 'standard': En fazla 12 bölüm ve 12 çoğaltma ile ayrılmış hizmet. 'standard2': Standarta benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir. 'standard3': 12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizine sahip 3 bölüme kadar) sahip en büyük Standart teklif. 'storage_optimized_l1': Bölüm başına en fazla 12 bölüm olmak üzere 1 TB'ı destekler. 'storage_optimized_l2': Bölüm başına en fazla 12 bölüm olmak üzere 2 TB'ı destekler.' 'temel'
'ücretsiz'
'standart'
'standard2'
'standard3'
'storage_optimized_l1'
'storage_optimized_l2'

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
SQL Veritabanı, Azure Cosmos DB, Azure Arama ile Web Uygulaması

Azure’a dağıtın
Bu şablon bir Web Uygulaması, bir SQL Veritabanı, Azure Cosmos DB, Azure Arama ve Application Insights sağlar.
Azure Bilişsel Arama hizmeti

Azure’a dağıtın
Bu şablon bir Azure Bilişsel Arama hizmeti oluşturur
Özel uç nokta ile Azure Bilişsel Arama hizmeti

Azure’a dağıtın
Bu şablon, özel uç nokta içeren bir Azure Bilişsel Arama hizmeti oluşturur.

ARM şablonu kaynak tanımı

searchServices kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft oluşturmak için. Arama/searchServices kaynağını şablonunuza aşağıdaki JSON dosyasını ekleyin.

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string"
  }
}

Özellik değerleri

searchServices

Ad Açıklama Değer
tür Kaynak türü 'Microsoft. Arama/searchServices'
apiVersion Kaynak API'sinin sürümü '2023-11-01'
name Kaynak adı dize (gerekli)
location Kaynağın bulunduğu coğrafi konum dize (gerekli)
etiketler Kaynak etiketleri. Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler
Sku Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Bu özellik, yeni bir arama hizmeti oluştururken gereklidir. Sku
identity Kaynağın kimliği. Kimlik
properties Arama hizmetinin özellikleri. SearchServiceProperties

Kimlik

Ad Açıklama Değer
tür Kimlik türü. 'Yok'
'SystemAssigned' (gerekli)

SearchServiceProperties

Ad Açıklama Değer
authSeçenekler Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz. DataPlaneAuthOptions
disableLocalAuth true olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz. bool
encryptionWithCmk Bir arama hizmeti içindeki customer manager anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir. EncryptionWithCmk
hostingMode Yalnızca standart3 SKU için geçerlidir. Bu özelliği, diğer SKU'lar için izin verilen en fazla dizinden çok daha yüksek olan 1000'e kadar dizine izin veren 3'e kadar yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz. Standart3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır. 'varsayılan'
'highDensity'
networkRuleSet Arama hizmetine nasıl ulaşılabileceğini belirleyen ağa özgü kurallar. NetworkRuleSet
partitionCount Arama hizmetindeki bölüm sayısı; belirtilirse 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır. int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 12
publicNetworkAccess Mevcut müşteri kaynakları ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, genel arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olabilir. 'devre dışı'
'etkin'
replicaCount Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında bir değer veya temel SKU için 1 ile 3 arasında bir değer olmalıdır. int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 12
semantik Arama Anlamsal aramanın kullanılabilirliğini denetleyebilen seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür. 'devre dışı'
'ücretsiz'
'standart'

DataPlaneAuthOptions

Ad Açıklama Değer
aadOrApiKey Kimlik doğrulaması için API anahtarının veya Microsoft Entra ID kiracıdaki bir erişim belirtecinin kullanılabileceğini gösterir. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Kimlik doğrulaması için yalnızca API anahtarının kullanılabileceğini gösterir.

DataPlaneAadOrApiKeyAuthOption

Ad Açıklama Değer
aadAuthFailureMode Bir arama hizmetinin veri düzlemi API'sinin kimlik doğrulaması başarısız olan istekler için hangi yanıtı göndereceğini açıklar. 'http401WithBearerChallenge'
'http403'

EncryptionWithCmk

Ad Açıklama Değer
Zorlama Bir arama hizmetinin müşteri tarafından şifrelenmemiş bir veya daha fazla kaynağa sahip olmayı nasıl zorunlu kılması gerektiğini açıklar. 'Devre Dışı'
'Etkin'
'Belirtilmemiş'

NetworkRuleSet

Ad Açıklama Değer
ipRules IP güvenlik duvarı için kullanılan IP kısıtlama kurallarının listesi. Kurallarla eşleşmeyen TÜM IP'ler güvenlik duvarı tarafından engellenir. Bu kurallar yalnızca arama hizmetinin 'publicNetworkAccess' değeri 'etkin' olduğunda uygulanır. IpRule[]

IpRule

Ad Açıklama Değer
değer Tek bir IPv4 adresine (örneğin, 123.1.2.3) veya CIDR biçiminde bir IP aralığına (örneğin, 123.1.2.3/24) karşılık gelen değere izin verilir. string

Sku

Ad Açıklama Değer
name Arama hizmetinin SKU'su. Geçerli değerler şunlardır: 'free': Paylaşılan hizmet. 'basic': En fazla 3 çoğaltması olan ayrılmış hizmet. 'standart': En fazla 12 bölüm ve 12 çoğaltma ile ayrılmış hizmet. 'standard2': Standartla benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir. 'standard3': 12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizin içeren en fazla 3 bölüme) sahip en büyük Standart teklif. 'storage_optimized_l1': Bölüm başına 12 bölüme kadar 1 TB destekler. 'storage_optimized_l2': Bölüm başına en fazla 12 bölüm olmak üzere 2 TB destekler.' 'temel'
'ücretsiz'
'standart'
'standard2'
'standard3'
'storage_optimized_l1'
'storage_optimized_l2'

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
SQL Veritabanı ile Web Uygulaması, Azure Cosmos DB, Azure Arama

Azure’a dağıtın
Bu şablon bir Web Uygulaması, bir SQL Veritabanı, Azure Cosmos DB, Azure Arama ve Application Insights sağlar.
Azure Bilişsel Arama hizmeti

Azure’a dağıtın
Bu şablon bir Azure Bilişsel Arama hizmeti oluşturur
Özel uç nokta ile Azure Bilişsel Arama hizmeti

Azure’a dağıtın
Bu şablon, özel uç nokta ile bir Azure Bilişsel Arama hizmeti oluşturur.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

searchServices kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft oluşturmak için. Arama/searchServices kaynağını şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
      }
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
    }
    sku = {
      name = "string"
    }
  })
}

Özellik değerleri

searchServices

Ad Açıklama Değer
tür Kaynak türü "Microsoft. Arama/searchServices@2023-11-01"
name Kaynak adı dize (gerekli)
location Kaynağın bulunduğu coğrafi konum dize (gerekli)
parent_id Bir kaynak grubuna dağıtmak için bu kaynak grubunun kimliğini kullanın. dize (gerekli)
etiketler Kaynak etiketleri. Etiket adlarının ve değerlerinin sözlüğü.
Sku Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Yeni bir arama hizmeti oluşturulurken bu özellik gereklidir. Sku
identity Kaynağın kimliği. Kimlik
properties Arama hizmetinin özellikleri. SearchServiceProperties

Kimlik

Ad Açıklama Değer
tür Kimlik türü. "SystemAssigned" (gerekli)

SearchServiceProperties

Ad Açıklama Değer
authOptions Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz. DataPlaneAuthOptions
disableLocalAuth true olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz. bool
encryptionWithCmk Bir arama hizmeti içindeki customer manager anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir. EncryptionWithCmk
hostingMode Yalnızca standart3 SKU için geçerlidir. Bu özelliği, diğer SKU'lar için izin verilen en fazla dizinden çok daha yüksek olan 1000'e kadar dizine izin veren 3'e kadar yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz. Standart3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır. "varsayılan"
"highDensity"
networkRuleSet Arama hizmetine nasıl ulaşılabileceğini belirleyen ağa özgü kurallar. NetworkRuleSet
partitionCount Arama hizmetindeki bölüm sayısı; belirtilirse 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır. int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 12
publicNetworkAccess Mevcut müşteri kaynakları ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, genel arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olabilir. "devre dışı"
"etkin"
replicaCount Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında bir değer veya temel SKU için 1 ile 3 arasında bir değer olmalıdır. int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 12
semantik Arama Anlamsal aramanın kullanılabilirliğini denetleyebilen seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür. "devre dışı"
"ücretsiz"
"standart"

DataPlaneAuthOptions

Ad Açıklama Değer
aadOrApiKey Kimlik doğrulaması için API anahtarının veya Microsoft Entra ID kiracıdaki bir erişim belirtecinin kullanılabileceğini gösterir. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Kimlik doğrulaması için yalnızca API anahtarının kullanılabileceğini gösterir.

DataPlaneAadOrApiKeyAuthOption

Ad Açıklama Değer
aadAuthFailureMode Bir arama hizmetinin veri düzlemi API'sinin kimlik doğrulaması başarısız olan istekler için hangi yanıtı göndereceğini açıklar. "http401WithBearerChallenge"
"http403"

EncryptionWithCmk

Ad Açıklama Değer
Zorlama Bir arama hizmetinin müşteri tarafından şifrelenmemiş bir veya daha fazla kaynağa sahip olmayı nasıl zorunlu kılması gerektiğini açıklar. "Devre dışı"
"Etkin"
"Belirtilmemiş"

NetworkRuleSet

Ad Açıklama Değer
ipRules IP güvenlik duvarı için kullanılan IP kısıtlama kurallarının listesi. Kurallarla eşleşmeyen IP'ler güvenlik duvarı tarafından engellenir. Bu kurallar yalnızca arama hizmetinin 'publicNetworkAccess' değeri 'etkin' olduğunda uygulanır. IpRule[]

IpRule

Ad Açıklama Değer
değer Tek bir IPv4 adresine (örneğin, 123.1.2.3) veya CIDR biçiminde bir IP aralığına (örneğin, 123.1.2.3/24) karşılık gelen değere izin verilir. string

Sku

Ad Açıklama Değer
name Arama hizmetinin SKU'su. Geçerli değerler şunlardır: 'free': Paylaşılan hizmet. 'basic': 3 çoğaltmaya kadar ayrılmış hizmet. 'standard': En fazla 12 bölüm ve 12 çoğaltma ile ayrılmış hizmet. 'standard2': Standarta benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir. 'standard3': 12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizine sahip 3 bölüme kadar) sahip en büyük Standart teklif. 'storage_optimized_l1': Bölüm başına en fazla 12 bölüm olmak üzere 1 TB'ı destekler. 'storage_optimized_l2': Bölüm başına en fazla 12 bölüm olmak üzere 2 TB'ı destekler.' "temel"
"ücretsiz"
"standart"
"standard2"
"standard3"
"storage_optimized_l1"
"storage_optimized_l2"