Microsoft.SearchServices

Definicja zasobu Bicep

Typ zasobu searchServices można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Search/searchServices, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

searchServices

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
tags Tagi zasobów. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
sku Jednostka SKU usługi wyszukiwania, która określa szybkość rozliczeń i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania. Numer jednostki magazynowej
identity Tożsamość zasobu. Tożsamość
properties Właściwości usługi wyszukiwania. Właściwości usługi wyszukiwania

Tożsamość

Nazwa Opis Wartość
typ Typ tożsamości. "Brak"
"SystemAssigned" (wymagane)

Właściwości usługi wyszukiwania

Nazwa Opis Wartość
authOptions Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli wartość "disableLocalAuth" ma wartość true. DataPlaneAuthOptions
disableLocalAuth Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions". bool
encryptionWithCmk Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania. EncryptionWithCmk
hostingMode Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna". "default"
"highDensity"
networkRuleSet Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę wyszukiwania. NetworkRuleSet
partitionCount Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 12
publicNetworkAccess Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu. "wyłączone"
"włączone"
replicaCount Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 12
semanticSearch Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko w przypadku niektórych jednostek SKU wyszukiwania w określonych lokalizacjach. "wyłączone"
"za darmo"
"standard"

DataPlaneAuthOptions

Nazwa Opis Wartość
aadOrApiKey Wskazuje, że na potrzeby uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Wskazuje, że tylko klucz interfejsu API może być używany do uwierzytelniania. W przypadku funkcji Bicep można użyć funkcji any().

DataPlaneAadOrApiKeyAuthOption

Nazwa Opis Wartość
aadAuthFailureMode Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania, która będzie wysyłać żądania, które zakończyły się niepowodzeniem uwierzytelniania. "http401WithBearerChallenge"
"http403"

EncryptionWithCmk

Nazwa Opis Wartość
Egzekwowania W tym artykule opisano, jak usługa wyszukiwania powinna wymuszać stosowanie co najmniej jednego zasobu niezaszyfrowanego przez klienta. "Wyłączone"
"Włączone"
"Nieokreślony"

NetworkRuleSet

Nazwa Opis Wartość
adresy IPRules Lista reguł ograniczeń adresów IP używanych dla zapory adresów IP. Wszystkie adresy IP niezgodne z regułami są blokowane przez zaporę. Te reguły są stosowane tylko wtedy, gdy element "publicNetworkAccess" usługi wyszukiwania jest "włączony". IpRule[]

Adres IPRule

Nazwa Opis Wartość
wartość Wartość odpowiadająca pojedynczemu adresowi IPv4 (na przykład 123.1.2.3) lub zakresowi adresów IP w formacie CIDR (na przykład 123.1.2.3/24) może być dozwolona. ciąg

SKU

Nazwa Opis Wartość
name Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobny do standardowego, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, maksymalnie 12 partycji. "basic"
"za darmo"
"standard"
"standard2"
"standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Aplikacja internetowa z SQL Database, Azure Cosmos DB, Azure Search

Wdróż na platformie Azure
Ten szablon aprowizuje aplikację internetową, SQL Database, Azure Cosmos DB, Azure Search i Application Insights.
usługa Azure Cognitive Search

Wdróż na platformie Azure
Ten szablon tworzy usługę Azure Cognitive Search
usługa Azure Cognitive Search z prywatnym punktem końcowym

Wdróż na platformie Azure
Ten szablon tworzy usługę Azure Cognitive Search z prywatnym punktem końcowym.

Definicja zasobu szablonu usługi ARM

Typ zasobu searchServices można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Search/searchServices, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Wartości właściwości

searchServices

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Search/searchServices"
apiVersion Wersja interfejsu API zasobów '2023-11-01'
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
tags Tagi zasobów. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
sku Jednostka SKU usługi wyszukiwania, która określa szybkość rozliczeń i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania. Numer jednostki magazynowej
identity Tożsamość zasobu. Tożsamość
properties Właściwości usługi wyszukiwania. Właściwości usługi wyszukiwania

Tożsamość

Nazwa Opis Wartość
typ Typ tożsamości. "Brak"
"SystemAssigned" (wymagane)

Właściwości usługi wyszukiwania

Nazwa Opis Wartość
authOptions Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli wartość "disableLocalAuth" ma wartość true. DataPlaneAuthOptions
disableLocalAuth Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions". bool
encryptionWithCmk Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania. EncryptionWithCmk
hostingMode Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna". "default"
"highDensity"
networkRuleSet Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę wyszukiwania. NetworkRuleSet
partitionCount Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 12
publicNetworkAccess Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu. "wyłączone"
"włączone"
replicaCount Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 12
semanticSearch Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach. "wyłączone"
"wolne"
"standard"

DataPlaneAuthOptions

Nazwa Opis Wartość
aadOrApiKey Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Wskazuje, że do uwierzytelniania może być używany tylko klucz interfejsu API.

DataPlaneAadOrApiKeyAuthOption

Nazwa Opis Wartość
aadAuthFailureMode Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania. "http401WithBearerChallenge"
"http403"

EncryptionWithCmk

Nazwa Opis Wartość
Egzekwowania Opisuje, jak usługa wyszukiwania powinna wymuszać posiadanie co najmniej jednego zasobu niezaszyfrowanego przez klienta. "Wyłączone"
"Włączone"
"Nieokreślony"

NetworkRuleSet

Nazwa Opis Wartość
adresy IPRules Lista reguł ograniczeń adresów IP używanych dla zapory adresów IP. Wszystkie adresy IP niezgodne z regułami są blokowane przez zaporę. Te reguły są stosowane tylko wtedy, gdy element "publicNetworkAccess" usługi wyszukiwania jest "włączony". IpRule[]

Adres IPRule

Nazwa Opis Wartość
wartość Wartość odpowiadająca pojedynczemu adresowi IPv4 (na przykład 123.1.2.3) lub zakresowi adresów IP w formacie CIDR (na przykład 123.1.2.3/24) może być dozwolona. ciąg

SKU

Nazwa Opis Wartość
name Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobny do standardowego, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, maksymalnie 12 partycji. "basic"
"za darmo"
"standard"
"standard2"
"standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Aplikacja internetowa z SQL Database, Azure Cosmos DB, Azure Search

Wdróż na platformie Azure
Ten szablon aprowizuje aplikację internetową, SQL Database, Azure Cosmos DB, Azure Search i Application Insights.
usługa Azure Cognitive Search

Wdróż na platformie Azure
Ten szablon tworzy usługę Azure Cognitive Search
usługa Azure Cognitive Search z prywatnym punktem końcowym

Wdróż na platformie Azure
Ten szablon tworzy usługę Azure Cognitive Search z prywatnym punktem końcowym.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu searchServices można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Search/searchServices, dodaj następujący program Terraform do szablonu.

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"
    }
  })
}

Wartości właściwości

searchServices

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Search/searchServices@2023-11-01"
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
parent_id Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. ciąg (wymagany)
tags Tagi zasobów. Słownik nazw tagów i wartości.
sku Jednostka SKU usługi wyszukiwania, która określa stawkę rozliczeń i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania. Numer jednostki magazynowej
identity Tożsamość zasobu. Tożsamość
properties Właściwości usługi wyszukiwania. Właściwości usługi wyszukiwania

Tożsamość

Nazwa Opis Wartość
typ Typ tożsamości. "SystemAssigned" (wymagane)

Właściwości usługi wyszukiwania

Nazwa Opis Wartość
authOptions Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true. DataPlaneAuthOptions
disableLocalAuth Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły używać kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions". bool
encryptionWithCmk Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania. EncryptionWithCmk
hostingMode Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalna liczba indeksów dozwolonych dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi mieć wartość domyślną. "default"
"highDensity"
networkRuleSet Reguły specyficzne dla sieci określające sposób uzyskiwania dostępu do usługi wyszukiwania. NetworkRuleSet
partitionCount Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 12
publicNetworkAccess Tę wartość można ustawić na wartość "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. W przypadku ustawienia wartości "disabled" ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a połączenia prywatnych punktów końcowych będą wyłączną metodą dostępu. "wyłączone"
"włączone"
replicaCount Liczba replik w usłudze wyszukiwania. Jeśli jest określona, musi być wartością z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 12
semanticSearch Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko w przypadku niektórych jednostek SKU wyszukiwania w określonych lokalizacjach. "wyłączone"
"za darmo"
"standard"

DataPlaneAuthOptions

Nazwa Opis Wartość
aadOrApiKey Wskazuje, że na potrzeby uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Wskazuje, że tylko klucz interfejsu API może być używany do uwierzytelniania.

DataPlaneAadOrApiKeyAuthOption

Nazwa Opis Wartość
aadAuthFailureMode Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania, która będzie wysyłać żądania, które zakończyły się niepowodzeniem uwierzytelniania. "http401WithBearerChallenge"
"http403"

EncryptionWithCmk

Nazwa Opis Wartość
Egzekwowania W tym artykule opisano, jak usługa wyszukiwania powinna wymuszać stosowanie co najmniej jednego zasobu niezaszyfrowanego przez klienta. "Wyłączone"
"Włączone"
"Nieokreślony"

NetworkRuleSet

Nazwa Opis Wartość
adresy IPRules Lista reguł ograniczeń adresów IP używanych dla zapory adresów IP. Wszystkie adresy IP niezgodne z regułami są blokowane przez zaporę. Te reguły są stosowane tylko wtedy, gdy element "publicNetworkAccess" usługi wyszukiwania jest "włączony". IpRule[]

Adres IPRule

Nazwa Opis Wartość
wartość Wartość odpowiadająca pojedynczemu adresowi IPv4 (na przykład 123.1.2.3) lub zakresowi adresów IP w formacie CIDR (na przykład 123.1.2.3/24) może być dozwolona. ciąg

SKU

Nazwa Opis Wartość
name Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobny do standardowego, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, maksymalnie 12 partycji. "basic"
"za darmo"
"standard"
"standard2"
"standard3"
"storage_optimized_l1"
"storage_optimized_l2"