Microsoft.Search searchサービス 2025-05-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 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.Search/searchServices@2025-05-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(...)
    }
    computeType: 'string'
    dataExfiltrationProtections: [
      'string'
    ]
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    endpoint: 'string'
    hostingMode: 'string'
    networkRuleSet: {
      bypass: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
    upgradeAvailable: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Search/searchServices

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

暗号化WithCmk

アイデンティティ

IdentityUserAssignedIdentities

Ipルール

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

SearchServiceプロパティ

SKU

追跡リソースタグ

ユーザー割り当て識別子

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

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

• リソースグループ - リソースグループのデプロイコマンドを参照してください。 各APIバージョンの変更プロパティ一覧は 変更ログをご覧ください。

使用例

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

次の Azure クイック スタート テンプレートでは、 このリソースの種類をデプロイします。

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

リソースの形式

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

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2025-05-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "computeType": "string",
    "dataExfiltrationProtections": [ "string" ],
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "endpoint": "string",
    "hostingMode": "string",
    "networkRuleSet": {
      "bypass": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string",
    "upgradeAvailable": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Search/searchServices

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

暗号化WithCmk

アイデンティティ

IdentityUserAssignedIdentities

Ipルール

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

SearchServiceプロパティ

SKU

追跡リソースタグ

ユーザー割り当て識別子

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 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2025-05-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 = ?
      }
      computeType = "string"
      dataExfiltrationProtections = [
        "string"
      ]
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      endpoint = "string"
      hostingMode = "string"
      networkRuleSet = {
        bypass = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
      upgradeAvailable = "string"
    }
    sku = {
      name = "string"
    }
  }
}

プロパティ値

Microsoft.Search/searchServices

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

暗号化WithCmk

アイデンティティ

IdentityUserAssignedIdentities

Ipルール

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

SearchServiceプロパティ

SKU

追跡リソースタグ

ユーザー割り当て識別子