Microsoft.Search searchServices 2022-09-01

[アーティクル]
12/20/2024

Bicep リソース定義

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

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

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

リソースの形式

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(Azure.Bicep.Types.Concrete.AnyType)
    }
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

名前	形容	価値
実施	1 つ以上の顧客以外の暗号化されたリソースを検索サービスで強制する方法について説明します。	'Disabled' 'Enabled' 'Unspecified'

同一性

名前	形容	価値
種類	ID の種類。	'None' 'SystemAssigned' (必須)

IpRule

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

Microsoft.Search/searchServices

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

NetworkRuleSet

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

SearchServiceProperties

名前	形容	価値
authOptions	検索サービスのデータプレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。	DataPlaneAuthOptions の
disableLocalAuth	true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。	bool
encryptionWithCmk	検索サービス内でカスタマーマネージャーキーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。	EncryptionWithCmk
hostingMode	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。他のすべての SKU の場合、この値は 'default' である必要があります。	'default' 'highDensity'
networkRuleSet	Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有のルール。	NetworkRuleSet
partitionCount	検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。	int 制約：最小値 = 1 最大値 = 12
publicNetworkAccess	この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他アクセス方式になります。	'disabled' 'enabled'
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 個のパーティションをサポートします。	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

名前	形容	価値

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

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

Bicep ファイル	形容
Azure AI Studio ネットワーク制限付きの	この一連のテンプレートでは、暗号化に Microsoft マネージドキーを使用し、AI リソースの Microsoft マネージド ID 構成を使用して、プライベートリンクとエグレスを無効にして Azure AI Studio を設定する方法を示します。
Azure Cognitive Search サービスの	このテンプレートは、Azure Cognitive Search サービスを作成します

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

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

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

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

リソースの形式

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

プロパティ値

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

名前	形容	価値
実施	1 つ以上の顧客以外の暗号化されたリソースを検索サービスで強制する方法について説明します。	'Disabled' 'Enabled' 'Unspecified'

同一性

名前	形容	価値
種類	ID の種類。	'None' 'SystemAssigned' (必須)

IpRule

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

Microsoft.Search/searchServices

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

NetworkRuleSet

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

SearchServiceProperties

名前	形容	価値
authOptions	検索サービスのデータプレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。	DataPlaneAuthOptions の
disableLocalAuth	true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。	bool
encryptionWithCmk	検索サービス内でカスタマーマネージャーキーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。	EncryptionWithCmk
hostingMode	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。他のすべての SKU の場合、この値は 'default' である必要があります。	'default' 'highDensity'
networkRuleSet	Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有のルール。	NetworkRuleSet
partitionCount	検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。	int 制約：最小値 = 1 最大値 = 12
publicNetworkAccess	この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他アクセス方式になります。	'disabled' 'enabled'
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 個のパーティションをサポートします。	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

名前	形容	価値

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

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

テンプレート	形容
Azure AI Studio ネットワーク制限付きの Azure にデプロイする	この一連のテンプレートでは、暗号化に Microsoft マネージドキーを使用し、AI リソースの Microsoft マネージド ID 構成を使用して、プライベートリンクとエグレスを無効にして Azure AI Studio を設定する方法を示します。
Azure Cognitive Search サービスの Azure にデプロイする	このテンプレートは、Azure Cognitive Search サービスを作成します
プライベートエンドポイントを使用して Azure Cognitive Search サービスをする Azure にデプロイする	このテンプレートは、プライベートエンドポイントを使用して Azure Cognitive Search サービスを作成します。
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリの Azure にデプロイする	このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。

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

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

リソースグループの

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

リソースの形式

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

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

プロパティ値

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

名前	形容	価値
実施	1 つ以上の顧客以外の暗号化されたリソースを検索サービスで強制する方法について説明します。	'Disabled' 'Enabled' 'Unspecified'

同一性

名前	形容	価値
種類	ID の種類。	'None' 'SystemAssigned' (必須)

IpRule

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

Microsoft.Search/searchServices

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

NetworkRuleSet

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

SearchServiceProperties

名前	形容	価値
authOptions	検索サービスのデータプレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。	DataPlaneAuthOptions の
disableLocalAuth	true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。	bool
encryptionWithCmk	検索サービス内でカスタマーマネージャーキーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。	EncryptionWithCmk
hostingMode	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。他のすべての SKU の場合、この値は 'default' である必要があります。	'default' 'highDensity'
networkRuleSet	Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有のルール。	NetworkRuleSet
partitionCount	検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。	int 制約：最小値 = 1 最大値 = 12
publicNetworkAccess	この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他アクセス方式になります。	'disabled' 'enabled'
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 個のパーティションをサポートします。	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

名前	形容	価値

次の方法で共有

Microsoft.Search searchServices 2022-09-01

Bicep リソース定義

リソースの形式

プロパティ値

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

同一性

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

SKU

TrackedResourceTags

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

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

リソースの形式

プロパティ値

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

同一性

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

SKU

TrackedResourceTags

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

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

リソースの形式

プロパティ値

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

同一性

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

SKU

TrackedResourceTags

フィードバック

その他のリソース

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

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

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