Microsoft.Search 検索サービス 2022-09-01

Bicep リソース定義

searchServices リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

使用例

Bicep サンプル

Search Service の展開の基本的な例。

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

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
検索サービス Search Service 用 AVM リソース モジュール

Azure クイック スタートのサンプル

次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル 形容
Azure AI Foundry Network の制限付き このテンプレート セットは、暗号化に Microsoft が管理するキーと AI リソースの Microsoft が管理する ID 構成を使用して、プライベート リンクとエグレスを無効にして Azure AI Foundry を設定する方法を示しています。
Azure Cognitive Search サービス の このテンプレートは、Azure Cognitive Search サービスを作成します
ユーザー マネージド ID を使用してネットワークセキュリティで保護されたエージェントを する この一連のテンプレートでは、AI サービス/AOAI 接続用のユーザー マネージド ID 認証とプライベート ネットワーク リンクを使用して仮想ネットワーク分離を使用して Azure AI エージェント サービスを設定し、エージェントをセキュリティで保護されたデータに接続する方法を示します。
Standard エージェントのセットアップ この一連のテンプレートは、標準セットアップで Azure AI Agent Service を設定する方法を示しています。つまり、プロジェクト/ハブ接続のマネージド ID 認証とパブリック インターネット アクセスが有効になっています。 エージェントは、顧客所有のシングルテナント検索およびストレージ リソースを使用します。 このセットアップでは、これらのリソースを完全に制御して表示できますが、使用量に基づいてコストが発生します。

リソースの形式

Microsoft.Search/searchServices リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Search/searchServices@2022-09-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: '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
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Search/searchServices

名前 形容 価値
ID リソースの ID。 ID
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名 string (必須)
プロパティ 検索サービスのプロパティ。 SearchServiceプロパティ
エスケーユー 価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。 SKU
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

DataPlaneAadOrApiKeyAuthOption

名前 形容 価値
aadAuthFailureMode 認証に失敗した要求に対して Search サービスのデータ プレーン API が送信する応答について説明します。 「http401WithBearerChallenge」
「http403」

DataPlaneAuthOptions

名前 形容 価値
aadOrApiKey API キーまたは Azure Active Directory からのアクセス トークンを認証に使用できることを示します。 DataPlaneAadOrApiKeyAuthOption の
apiKeyのみ 認証に API キーのみを使用する必要があることを示します。 任意

暗号化WithCmk

名前 形容 価値
実施 1 つ以上の顧客以外の暗号化されたリソースを検索サービスで強制する方法について説明します。 「無効」
「有効」
「未指定」

同一性

名前 形容 価値
型 ID の種類。 「なし」
'SystemAssigned' (必須)

Ipルール

名前 形容 価値
価値 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。 文字列

ネットワークルールセット

名前 形容 価値
ipルール 検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP ルールを使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。 Ipルール[]

SearchServiceプロパティ

名前 形容 価値
認証オプション 検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。 DataPlaneAuthOptions の
disableLocalAuth true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。 ブール (bool)
暗号化WithCmk 検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。 暗号化WithCmk
ホスティングモード Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。 'デフォルト'
「高密度」
ネットワークルールセット Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有のルール。 ネットワークルールセット
パーティション数 検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。 int

制約:
最小値 = 1
最大値 = 12
publicNetworkAccess (パブリックネットワークアクセス) この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方式になります。 '無効'
'有効'
replicaCount (レプリカ数) 検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。 int

制約:
最小値 = 1
最大値 = 12

SKU

名前 形容 価値
名前 検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。 「ベーシック」
「無料」
「スタンダード」
「スタンダード2」
'スタンダード3'
「storage_optimized_l1」
「storage_optimized_l2」

追跡リソースタグ

名前 形容 価値

ARM テンプレート リソース定義

searchServices リソースの種類は、次を対象とする操作と共にデプロイできます。

使用例

Azure クイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
Azure AI Foundry Network の制限付き

Azure にデプロイする
このテンプレート セットは、暗号化に Microsoft が管理するキーと AI リソースの Microsoft が管理する ID 構成を使用して、プライベート リンクとエグレスを無効にして Azure AI Foundry を設定する方法を示しています。
Azure Cognitive Search サービス の

Azure
にデプロイする
このテンプレートは、Azure Cognitive Search サービスを作成します
プライベート エンドポイント を使用して Azure Cognitive Search サービスを する

Azure
にデプロイする
このテンプレートは、プライベート エンドポイントを使用して Azure Cognitive Search サービスを作成します。
ユーザー マネージド ID を使用してネットワークセキュリティで保護されたエージェントを する

Azure にデプロイする
この一連のテンプレートでは、AI サービス/AOAI 接続用のユーザー マネージド ID 認証とプライベート ネットワーク リンクを使用して仮想ネットワーク分離を使用して Azure AI エージェント サービスを設定し、エージェントをセキュリティで保護されたデータに接続する方法を示します。
Standard エージェントのセットアップ

Azure にデプロイする
この一連のテンプレートは、標準セットアップで Azure AI Agent Service を設定する方法を示しています。つまり、プロジェクト/ハブ接続のマネージド ID 認証とパブリック インターネット アクセスが有効になっています。 エージェントは、顧客所有のシングルテナント検索およびストレージ リソースを使用します。 このセットアップでは、これらのリソースを完全に制御して表示できますが、使用量に基づいてコストが発生します。
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリの

Azure
にデプロイする
このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。

リソースの形式

Microsoft.Search/searchServices リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2022-09-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Search/searchServices

名前 形容 価値
apiVersion (英語) API のバージョン '2022-09-01'
ID リソースの ID。 ID
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名 string (必須)
プロパティ 検索サービスのプロパティ。 SearchServiceプロパティ
エスケーユー 価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。 SKU
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
型 リソースの種類 'Microsoft.Search/searchServices'

DataPlaneAadOrApiKeyAuthOption

名前 形容 価値
aadAuthFailureMode 認証に失敗した要求に対して Search サービスのデータ プレーン API が送信する応答について説明します。 「http401WithBearerChallenge」
「http403」

DataPlaneAuthOptions

名前 形容 価値
aadOrApiKey API キーまたは Azure Active Directory からのアクセス トークンを認証に使用できることを示します。 DataPlaneAadOrApiKeyAuthOption の
apiKeyのみ 認証に API キーのみを使用する必要があることを示します。 任意

暗号化WithCmk

名前 形容 価値
実施 1 つ以上の顧客以外の暗号化されたリソースを検索サービスで強制する方法について説明します。 「無効」
「有効」
「未指定」

同一性

名前 形容 価値
型 ID の種類。 「なし」
'SystemAssigned' (必須)

Ipルール

名前 形容 価値
価値 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。 文字列

ネットワークルールセット

名前 形容 価値
ipルール 検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP ルールを使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。 Ipルール[]

SearchServiceプロパティ

名前 形容 価値
認証オプション 検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。 DataPlaneAuthOptions の
disableLocalAuth true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。 ブール (bool)
暗号化WithCmk 検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。 暗号化WithCmk
ホスティングモード Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。 'デフォルト'
「高密度」
ネットワークルールセット Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有のルール。 ネットワークルールセット
パーティション数 検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。 int

制約:
最小値 = 1
最大値 = 12
publicNetworkAccess (パブリックネットワークアクセス) この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方式になります。 '無効'
'有効'
replicaCount (レプリカ数) 検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。 int

制約:
最小値 = 1
最大値 = 12

SKU

名前 形容 価値
名前 検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。 「ベーシック」
「無料」
「スタンダード」
「スタンダード2」
'スタンダード3'
「storage_optimized_l1」
「storage_optimized_l2」

追跡リソースタグ

名前 形容 価値

Terraform (AzAPI プロバイダー) リソース定義

searchServices リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソースグループ 各APIバージョンの変更プロパティ一覧については、 変更ログをご覧ください。

使用例

Terraformサンプル

Search Service の展開の基本的な例。

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    = ["*"]
}

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
検索サービス Search Service 用 AVM リソース モジュール

リソースの形式

Microsoft.Search/searchServices リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2022-09-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
    }
    sku = {
      name = "string"
    }
  }
}

プロパティ値

Microsoft.Search/searchServices

名前 形容 価値
ID リソースの ID。 ID
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名 string (必須)
プロパティ 検索サービスのプロパティ。 SearchServiceプロパティ
エスケーユー 価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。 SKU
タグ リソース タグ タグ名と値のディクショナリ。
型 リソースの種類 "Microsoft.Search/searchServices@2022-09-01"

DataPlaneAadOrApiKeyAuthOption

名前 形容 価値
aadAuthFailureMode 認証に失敗した要求に対して Search サービスのデータ プレーン API が送信する応答について説明します。 「http401WithBearerChallenge」
「http403」

DataPlaneAuthOptions

名前 形容 価値
aadOrApiKey API キーまたは Azure Active Directory からのアクセス トークンを認証に使用できることを示します。 DataPlaneAadOrApiKeyAuthOption の
apiKeyのみ 認証に API キーのみを使用する必要があることを示します。 任意

暗号化WithCmk

名前 形容 価値
実施 1 つ以上の顧客以外の暗号化されたリソースを検索サービスで強制する方法について説明します。 「無効」
「有効」
「未指定」

同一性

名前 形容 価値
型 ID の種類。 「なし」
'SystemAssigned' (必須)

Ipルール

名前 形容 価値
価値 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。 文字列

ネットワークルールセット

名前 形容 価値
ipルール 検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP ルールを使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。 Ipルール[]

SearchServiceプロパティ

名前 形容 価値
認証オプション 検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。 DataPlaneAuthOptions の
disableLocalAuth true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。 ブール (bool)
暗号化WithCmk 検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。 暗号化WithCmk
ホスティングモード Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。 'デフォルト'
「高密度」
ネットワークルールセット Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有のルール。 ネットワークルールセット
パーティション数 検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。 int

制約:
最小値 = 1
最大値 = 12
publicNetworkAccess (パブリックネットワークアクセス) この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方式になります。 '無効'
'有効'
replicaCount (レプリカ数) 検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。 int

制約:
最小値 = 1
最大値 = 12

SKU

名前 形容 価値
名前 検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。 「ベーシック」
「無料」
「スタンダード」
「スタンダード2」
'スタンダード3'
「storage_optimized_l1」
「storage_optimized_l2」

追跡リソースタグ

名前 形容 価値