Microsoft.SearchServices 2019-10-01-preview

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 dziennika zmian.

Przykłady użycia

Przykłady Bicep

Podstawowy przykład wdrażania usługi wyszukiwania.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource searchService 'Microsoft.Search/searchServices@2022-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'standard'
  }
  properties: {
    authOptions: {
      apiKeyOnly: {}
    }
    disableLocalAuth: false
    encryptionWithCmk: {
      enforcement: 'Disabled'
    }
    hostingMode: 'default'
    networkRuleSet: {
      ipRules: []
    }
    partitionCount: 1
    publicNetworkAccess: 'Enabled'
    replicaCount: 1
  }
  tags: {
    environment: 'staging'
  }
}

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Moduł Opis
usługi wyszukiwania Moduł zasobów AVM dla usługi wyszukiwania

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
Sieć Azure AI Foundry z ograniczeniami Ten zestaw szablonów pokazuje, jak skonfigurować usługę Azure AI Foundry z wyłączonym linkiem prywatnym i ruchem wychodzącym przy użyciu kluczy zarządzanych przez firmę Microsoft do szyfrowania i konfiguracji tożsamości zarządzanej przez firmę Microsoft dla zasobu sztucznej inteligencji.
usługi Azure Cognitive Search Ten szablon tworzy usługę Azure Cognitive Search
Network Secured Agent z tożsamością zarządzaną użytkownika Ten zestaw szablonów przedstawia sposób konfigurowania usługi Azure AI Agent Service z izolacją sieci wirtualnej przy użyciu uwierzytelniania tożsamości zarządzanej przez użytkownika dla połączenia usługi AI/AOAI i łączy sieci prywatnej w celu połączenia agenta z bezpiecznymi danymi.
Standardowa instalacja agenta Ten zestaw szablonów pokazuje, jak skonfigurować usługę Azure AI Agent Service ze standardową konfiguracją, co oznacza, że w przypadku uwierzytelniania tożsamości zarządzanej dla połączeń projektu/centrum i publicznego dostępu do Internetu włączono. Agenci korzystają z zasobów wyszukiwania i magazynowania z jedną dzierżawą należących do klienta. Dzięki tej konfiguracji masz pełną kontrolę nad tymi zasobami i widoczność, ale koszty będą naliczane na podstawie użycia.

Format zasobu

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

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

Wartości właściwości

Microsoft.Search/searchServices

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. Tożsamość
lokalizacja Lokalizacja geograficzna zasobu. Musi to być jeden z obsługiwanych i zarejestrowanych regionów geograficznych platformy Azure (na przykład Zachodnie stany USA, Wschodnie stany USA, Azja Południowo-Wschodnia itd.). Ta właściwość jest wymagana podczas tworzenia nowego zasobu. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości usługi Search. Właściwości usługi wyszukiwania
Numer jednostki magazynowej Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania. sku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Tożsamość

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

Adres IPRule

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

Zestaw reguł sieciowych

Nazwa Opis Wartość
Dostęp do punktu końcowego Poziom dostępu do punktu końcowego usługi wyszukiwania. Publiczny punkt końcowy usługi wyszukiwania jest dostępny z Internetu. Prywatny dostęp do punktu końcowego usługi wyszukiwania można uzyskać tylko za pośrednictwem prywatnych punktów końcowych. Wartość domyślna to Publiczna. "Prywatny"
"Publiczny"
Reguły ip Lista reguł ograniczeń adresów IP definiujących przychodzący dostęp sieciowy do punktu końcowego usługi wyszukiwania. Te reguły ograniczeń są stosowane tylko wtedy, gdy funkcja EndpointAccess usługi wyszukiwania jest publiczna. IpRule []

Tagi zasobów

Nazwa Opis Wartość

Właściwości usługi wyszukiwania

Nazwa Opis Wartość
Tryb hostingowy 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ż maksymalne indeksy dozwolone 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 być wartością domyślną. "wartość domyślna"
"highDensity"
networkRuleSet (zestaw reguł sieciowych) Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure Cognitive Search. Zestaw reguł sieciowych
liczba partycji 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
Wartość maksymalna = 12
Liczba replik 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
Wartość maksymalna = 12

Numer jednostki magazynowej

Nazwa Opis Wartość
nazwa Jednostka SKU usługi Search. 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 wartość "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"

Definicja zasobu szablonu usługi ARM

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

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
Sieć Azure AI Foundry z ograniczeniami

wdrażanie w usłudze Azure
Ten zestaw szablonów pokazuje, jak skonfigurować usługę Azure AI Foundry z wyłączonym linkiem prywatnym i ruchem wychodzącym przy użyciu kluczy zarządzanych przez firmę Microsoft do szyfrowania i konfiguracji tożsamości zarządzanej przez firmę Microsoft dla zasobu sztucznej inteligencji.
usługi Azure Cognitive Search

wdrażanie w usłudze Azure
Ten szablon tworzy usługę Azure Cognitive Search
usługa Azure Cognitive Search z prywatnym punktem końcowym

wdrażanie w usłudze Azure
Ten szablon tworzy usługę Azure Cognitive Search z prywatnym punktem końcowym.
Network Secured Agent z tożsamością zarządzaną użytkownika

wdrażanie w usłudze Azure
Ten zestaw szablonów przedstawia sposób konfigurowania usługi Azure AI Agent Service z izolacją sieci wirtualnej przy użyciu uwierzytelniania tożsamości zarządzanej przez użytkownika dla połączenia usługi AI/AOAI i łączy sieci prywatnej w celu połączenia agenta z bezpiecznymi danymi.
Standardowa instalacja agenta

wdrażanie w usłudze Azure
Ten zestaw szablonów pokazuje, jak skonfigurować usługę Azure AI Agent Service ze standardową konfiguracją, co oznacza, że w przypadku uwierzytelniania tożsamości zarządzanej dla połączeń projektu/centrum i publicznego dostępu do Internetu włączono. Agenci korzystają z zasobów wyszukiwania i magazynowania z jedną dzierżawą należących do klienta. Dzięki tej konfiguracji masz pełną kontrolę nad tymi zasobami i widoczność, ale koszty będą naliczane na podstawie użycia.
web app with a SQL Database, Azure Cosmos DB, Azure Search

wdrażanie w usłudze Azure
Ten szablon aprowizuje aplikację internetową, bazę danych SQL Database, usługę Azure Cosmos DB, usługę Azure Search i usługę Application Insights.

Format zasobu

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

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

Wartości właściwości

Microsoft.Search/searchServices

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2019-10-01-preview"
tożsamość Tożsamość zasobu. Tożsamość
lokalizacja Lokalizacja geograficzna zasobu. Musi to być jeden z obsługiwanych i zarejestrowanych regionów geograficznych platformy Azure (na przykład Zachodnie stany USA, Wschodnie stany USA, Azja Południowo-Wschodnia itd.). Ta właściwość jest wymagana podczas tworzenia nowego zasobu. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości usługi Search. Właściwości usługi wyszukiwania
Numer jednostki magazynowej Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania. sku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Search/searchServices"

Tożsamość

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

Adres IPRule

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

Zestaw reguł sieciowych

Nazwa Opis Wartość
Dostęp do punktu końcowego Poziom dostępu do punktu końcowego usługi wyszukiwania. Publiczny punkt końcowy usługi wyszukiwania jest dostępny z Internetu. Prywatny dostęp do punktu końcowego usługi wyszukiwania można uzyskać tylko za pośrednictwem prywatnych punktów końcowych. Wartość domyślna to Publiczna. "Prywatny"
"Publiczny"
Reguły ip Lista reguł ograniczeń adresów IP definiujących przychodzący dostęp sieciowy do punktu końcowego usługi wyszukiwania. Te reguły ograniczeń są stosowane tylko wtedy, gdy funkcja EndpointAccess usługi wyszukiwania jest publiczna. IpRule []

Tagi zasobów

Nazwa Opis Wartość

Właściwości usługi wyszukiwania

Nazwa Opis Wartość
Tryb hostingowy 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ż maksymalne indeksy dozwolone 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 być wartością domyślną. "wartość domyślna"
"highDensity"
networkRuleSet (zestaw reguł sieciowych) Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure Cognitive Search. Zestaw reguł sieciowych
liczba partycji 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
Wartość maksymalna = 12
Liczba replik 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
Wartość maksymalna = 12

Numer jednostki magazynowej

Nazwa Opis Wartość
nazwa Jednostka SKU usługi Search. 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 wartość "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"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania usługi wyszukiwania.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "searchService" {
  type      = "Microsoft.Search/searchServices@2022-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      authOptions = {
        apiKeyOnly = {
        }
      }
      disableLocalAuth = false
      encryptionWithCmk = {
        enforcement = "Disabled"
      }
      hostingMode = "default"
      networkRuleSet = {
        ipRules = [
        ]
      }
      partitionCount      = 1
      publicNetworkAccess = "Enabled"
      replicaCount        = 1
    }
    sku = {
      name = "standard"
    }
    tags = {
      environment = "staging"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Moduł Opis
usługi wyszukiwania Moduł zasobów AVM dla usługi wyszukiwania

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

Wartości właściwości

Microsoft.Search/searchServices

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. Tożsamość
lokalizacja Lokalizacja geograficzna zasobu. Musi to być jeden z obsługiwanych i zarejestrowanych regionów geograficznych platformy Azure (na przykład Zachodnie stany USA, Wschodnie stany USA, Azja Południowo-Wschodnia itd.). Ta właściwość jest wymagana podczas tworzenia nowego zasobu. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości usługi Search. Właściwości usługi wyszukiwania
Numer jednostki magazynowej Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania. sku
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Search/searchServices@2019-10-01-preview"

Tożsamość

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

Adres IPRule

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

Zestaw reguł sieciowych

Nazwa Opis Wartość
Dostęp do punktu końcowego Poziom dostępu do punktu końcowego usługi wyszukiwania. Publiczny punkt końcowy usługi wyszukiwania jest dostępny z Internetu. Prywatny dostęp do punktu końcowego usługi wyszukiwania można uzyskać tylko za pośrednictwem prywatnych punktów końcowych. Wartość domyślna to Publiczna. "Prywatny"
"Publiczny"
Reguły ip Lista reguł ograniczeń adresów IP definiujących przychodzący dostęp sieciowy do punktu końcowego usługi wyszukiwania. Te reguły ograniczeń są stosowane tylko wtedy, gdy funkcja EndpointAccess usługi wyszukiwania jest publiczna. IpRule []

Tagi zasobów

Nazwa Opis Wartość

Właściwości usługi wyszukiwania

Nazwa Opis Wartość
Tryb hostingowy 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ż maksymalne indeksy dozwolone 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 być wartością domyślną. "wartość domyślna"
"highDensity"
networkRuleSet (zestaw reguł sieciowych) Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure Cognitive Search. Zestaw reguł sieciowych
liczba partycji 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
Wartość maksymalna = 12
Liczba replik 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
Wartość maksymalna = 12

Numer jednostki magazynowej

Nazwa Opis Wartość
nazwa Jednostka SKU usługi Search. 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 wartość "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"