Microsoft.Search searchServices 2022-09-01
Bicep リソース定義
searchServices リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Search/searchServices リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Search/searchServices@2022-09-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
}
}
プロパティ値
searchServices
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) |
| location | リソースが保存されている地理的な場所 | string (必須) |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| sku | 価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。 | SKU |
| identity | リソースの ID。 | ID |
| properties | 検索サービスのプロパティ。 | SearchServiceProperties |
ID
| 名前 | 説明 | 値 |
|---|---|---|
| type | ID の種類。 | 'None' 'SystemAssigned' (必須) |
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' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方法になります。 | 'disabled' 'enabled' |
| replicaCount | 検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、基本 SKU の場合は 1 から 3 までの値である必要があります。 | INT 制約: 最小値 = 1 最大値 = 12 |
DataPlaneAuthOptions
| 名前 | 説明 | 値 |
|---|---|---|
| aadOrApiKey | AZURE Active Directory の API キーまたはアクセス トークンを認証に使用できることを示します。 | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | 認証に API キーのみを使用する必要があることを示します。 | Bicep の場合は、 any() 関数を使用できます。 |
DataPlaneAadOrApiKeyAuthOption
| 名前 | 説明 | 値 |
|---|---|---|
| aadAuthFailureMode | 認証に失敗した要求に対してSearch Serviceのデータ プレーン API が送信する応答について説明します。 | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| 名前 | 説明 | 値 |
|---|---|---|
| 施行 | 検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。 | 'Disabled' 'Enabled' 'Unspecified' |
NetworkRuleSet
| 名前 | 説明 | 値 |
|---|---|---|
| ipRules | 検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP 規則を使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他的アクセス方法になります。 | IpRule[] |
IpRule
| 名前 | 説明 | 値 |
|---|---|---|
| value | 許可される 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。 | string |
Sku
| 名前 | 説明 | 値 |
|---|---|---|
| name | 検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 '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' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ |
このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。 |
| Azure Cognitive Search サービス |
このテンプレートは、Azure Cognitive Search サービスを作成します |
| プライベート エンドポイントを使用したサービスのAzure Cognitive Search |
このテンプレートは、プライベート エンドポイントを使用してAzure Cognitive Search サービスを作成します。 |
ARM テンプレート リソース定義
searchServices リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Search/searchServices リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2022-09-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"
}
}
プロパティ値
searchServices
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Search/searchServices' |
| apiVersion | リソース API のバージョン | '2022-09-01' |
| name | リソース名 | string (必須) |
| location | リソースが保存されている地理的な場所 | string (必須) |
| tags | リソース タグ。 | タグ名と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| sku | 価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。 | SKU |
| identity | リソースの ID。 | ID |
| properties | 検索サービスのプロパティ。 | SearchServiceProperties |
ID
| 名前 | 説明 | 値 |
|---|---|---|
| type | ID の種類。 | 'None' 'SystemAssigned' (必須) |
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' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方法になります。 | 'disabled' 'enabled' |
| replicaCount | 検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、基本 SKU の場合は 1 から 3 までの値である必要があります。 | INT 制約: 最小値 = 1 最大値 = 12 |
DataPlaneAuthOptions
| 名前 | 説明 | 値 |
|---|---|---|
| aadOrApiKey | API キーまたは Azure Active Directory からのアクセス トークンを認証に使用できることを示します。 | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | 認証に API キーのみを使用する必要があることを示します。 |
DataPlaneAadOrApiKeyAuthOption
| 名前 | 説明 | 値 |
|---|---|---|
| aadAuthFailureMode | 認証に失敗した要求に対してSearch Serviceのデータ プレーン API が送信する応答について説明します。 | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| 名前 | 説明 | 値 |
|---|---|---|
| 施行 | 検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。 | 'Disabled' 'Enabled' 'Unspecified' |
NetworkRuleSet
| 名前 | 説明 | 値 |
|---|---|---|
| ipRules | 検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP 規則を使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他的アクセス方法になります。 | IpRule[] |
IpRule
| 名前 | 説明 | 値 |
|---|---|---|
| value | 許可される 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。 | string |
Sku
| 名前 | 説明 | 値 |
|---|---|---|
| name | 検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 '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' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ |
このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。 |
| Azure Cognitive Search サービス |
このテンプレートは、Azure Cognitive Search サービスを作成します |
| プライベート エンドポイントを使用したサービスのAzure Cognitive Search |
このテンプレートは、プライベート エンドポイントを使用してAzure Cognitive Search サービスを作成します。 |
Terraform (AzAPI プロバイダー) リソース定義
searchServices リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Search/searchServices リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2022-09-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
}
sku = {
name = "string"
}
})
}
プロパティ値
searchServices
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Search/searchServices@2022-09-01" |
| name | リソース名 | string (必須) |
| location | リソースが保存されている地理的な場所 | string (必須) |
| parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
| tags | リソース タグ。 | タグ名と値のディクショナリ。 |
| sku | 価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。 | SKU |
| identity | リソースの ID。 | ID |
| properties | 検索サービスのプロパティ。 | SearchServiceProperties |
ID
| 名前 | 説明 | 値 |
|---|---|---|
| type | ID の種類。 | "SystemAssigned" (必須) |
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' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。 | "disabled" "enabled" |
| replicaCount | 検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。 | INT 制約: 最小値 = 1 最大値 = 12 |
DataPlaneAuthOptions
| 名前 | 説明 | 値 |
|---|---|---|
| aadOrApiKey | AZURE Active Directory の API キーまたはアクセス トークンを認証に使用できることを示します。 | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | 認証に API キーのみを使用する必要があることを示します。 |
DataPlaneAadOrApiKeyAuthOption
| 名前 | 説明 | 値 |
|---|---|---|
| aadAuthFailureMode | 認証に失敗した要求に対してSearch Serviceのデータ プレーン API が送信する応答について説明します。 | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| 名前 | 説明 | 値 |
|---|---|---|
| 施行 | 検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。 | "無効" "有効" "Unspecified" |
NetworkRuleSet
| 名前 | 説明 | 値 |
|---|---|---|
| ipRules | 検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP 規則を使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他的アクセス方法になります。 | IpRule[] |
IpRule
| 名前 | 説明 | 値 |
|---|---|---|
| value | 許可される 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。 | string |
Sku
| 名前 | 説明 | 値 |
|---|---|---|
| name | 検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 '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" |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示