Microsoft.Search searchServices
Definisi sumber daya Bicep
Jenis sumber daya searchServices dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.Search/searchServices, tambahkan Bicep berikut ke templat Anda.
resource symbolicname 'Microsoft.Search/searchServices@2023-11-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
semanticSearch: 'string'
}
}
Nilai properti
searchServices
| Nama | Deskripsi | Nilai |
|---|---|---|
| nama | Nama sumber daya | string (diperlukan) |
| lokasi | Lokasi geografis tempat sumber daya berada | string (diperlukan) |
| tag | Tag sumber daya. | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| sku | SKU layanan pencarian, yang menentukan tingkat penagihan dan batas kapasitas. Properti ini diperlukan saat membuat layanan pencarian baru. | Sku |
| identity | Identitas sumber daya. | Identitas |
| properti | Properti layanan pencarian. | SearchServiceProperties |
Identitas
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas. | 'Tidak Ada' 'SystemAssigned' (diperlukan) |
SearchServiceProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| authOptions | Menentukan opsi tentang bagaimana API sarana data dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true. | DataPlaneAuthOptions |
| disableLocalAuth | Ketika diatur ke true, panggilan ke layanan pencarian tidak akan diizinkan untuk menggunakan kunci API untuk autentikasi. Ini tidak dapat diatur ke true jika 'dataPlaneAuthOptions' ditentukan. | bool |
| encryptionWithCmk | Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian. | EncryptionWithCmk |
| hostingMode | Hanya berlaku untuk SKU standar3. Anda dapat mengatur properti ini untuk mengaktifkan hingga 3 partisi kepadatan tinggi yang memungkinkan hingga 1000 indeks, yang jauh lebih tinggi dari indeks maksimum yang diizinkan untuk SKU lainnya. Untuk SKU standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'. | 'default' 'HighDensity' |
| networkRuleSet | Aturan khusus jaringan yang menentukan bagaimana layanan pencarian dapat dicapai. | NetworkRuleSet |
| partitionCount | Jumlah partisi dalam layanan pencarian; jika ditentukan, bisa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya berlaku untuk SKU standar. Untuk layanan 'standar3' dengan hostingMode diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3. | int Batasan: Nilai min = 1 Nilai maks = 12 |
| publicNetworkAccess | Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang melanggar pada sumber daya dan templat pelanggan yang ada. Jika diatur ke 'dinonaktifkan', lalu lintas melalui antarmuka publik tidak diizinkan, dan koneksi titik akhir privat akan menjadi metode akses eksklusif. | 'dinonaktifkan' 'diaktifkan' |
| replicaCount | Jumlah replika dalam layanan pencarian. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar. | int Batasan: Nilai min = 1 Nilai maks = 12 |
| semanticSearch | Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU pencarian tertentu di lokasi tertentu. | 'dinonaktifkan' 'bebas' 'standar' |
DataPlaneAuthOptions
| Nama | Deskripsi | Nilai |
|---|---|---|
| aadOrApiKey | Menunjukkan bahwa kunci API atau token akses dari penyewa Microsoft Entra ID dapat digunakan untuk autentikasi. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Menunjukkan bahwa hanya kunci API yang dapat digunakan untuk autentikasi. | Untuk Bicep, Anda dapat menggunakan fungsi any(). |
DataPlaneAadOrApiKeyAuthOption
| Nama | Deskripsi | Nilai |
|---|---|---|
| aadAuthFailureMode | Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi. | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| Nama | Deskripsi | Nilai |
|---|---|---|
| Penegakan | Menjelaskan bagaimana layanan pencarian harus memberlakukan memiliki satu atau beberapa sumber daya yang tidak dienkripsi pelanggan. | 'Dinonaktifkan' 'Diaktifkan' 'Tidak ditentukan' |
NetworkRuleSet
| Nama | Deskripsi | Nilai |
|---|---|---|
| ipRules | Daftar aturan pembatasan IP yang digunakan untuk firewall IP. IP apa pun yang tidak cocok dengan aturan diblokir oleh firewall. Aturan ini hanya diterapkan ketika 'publicNetworkAccess' dari layanan pencarian 'diaktifkan'. | IpRule[] |
IpRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| nilai | Nilai yang sesuai dengan satu alamat IPv4 (misalnya, 123.1.2.3) atau rentang IP dalam format CIDR (misalnya, 123.1.2.3/24) diizinkan. | string |
SKU
| Nama | Deskripsi | Nilai |
|---|---|---|
| nama | SKU layanan pencarian. Nilai yang valid meliputi: 'gratis': Layanan bersama. 'dasar': Layanan khusus dengan hingga 3 replika. 'standar': Layanan khusus dengan hingga 12 partisi dan 12 replika. 'standard2': Mirip dengan standar, tetapi dengan kapasitas lebih per unit pencarian. 'standard3': Penawaran Standar terbesar dengan hingga 12 partisi dan 12 replika (atau hingga 3 partisi dengan lebih banyak indeks jika Anda juga mengatur properti hostingMode ke 'highDensity'). 'storage_optimized_l1': Mendukung 1 TB per partisi, hingga 12 partisi. 'storage_optimized_l2': Mendukung 2TB per partisi, hingga 12 partisi.' | 'dasar' 'bebas' 'standar' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
Aplikasi Web dengan SQL Database, Azure Cosmos DB, Azure Search |
Templat ini menyediakan Aplikasi Web, SQL Database, Azure Cosmos DB, Azure Search, dan Application Insights. |
| Layanan Azure Cognitive Search |
Templat ini membuat layanan Azure Cognitive Search |
| layanan Azure Cognitive Search dengan titik akhir privat |
Templat ini membuat layanan Azure Cognitive Search dengan titik akhir privat. |
Definisi sumber daya templat ARM
Jenis sumber daya searchServices dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.Search/searchServices, tambahkan JSON berikut ke templat Anda.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2023-11-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",
"semanticSearch": "string"
}
}
Nilai properti
searchServices
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | 'Microsoft.Search/searchServices' |
| apiVersion | Versi api sumber daya | '2023-11-01' |
| nama | Nama sumber daya | string (diperlukan) |
| lokasi | Lokasi geografis tempat sumber daya berada | string (diperlukan) |
| tag | Tag sumber daya. | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| sku | SKU layanan pencarian, yang menentukan tingkat penagihan dan batas kapasitas. Properti ini diperlukan saat membuat layanan pencarian baru. | Sku |
| identity | Identitas sumber daya. | Identitas |
| properti | Properti layanan pencarian. | SearchServiceProperties |
Identitas
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas. | 'Tidak Ada' 'SystemAssigned' (diperlukan) |
SearchServiceProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| authOptions | Menentukan opsi tentang bagaimana API sarana data dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true. | DataPlaneAuthOptions |
| disableLocalAuth | Ketika diatur ke true, panggilan ke layanan pencarian tidak akan diizinkan untuk menggunakan kunci API untuk autentikasi. Ini tidak dapat diatur ke true jika 'dataPlaneAuthOptions' ditentukan. | bool |
| encryptionWithCmk | Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian. | EncryptionWithCmk |
| hostingMode | Hanya berlaku untuk SKU standar3. Anda dapat mengatur properti ini untuk mengaktifkan hingga 3 partisi kepadatan tinggi yang memungkinkan hingga 1000 indeks, yang jauh lebih tinggi dari indeks maksimum yang diizinkan untuk SKU lainnya. Untuk SKU standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'. | 'default' 'HighDensity' |
| networkRuleSet | Aturan khusus jaringan yang menentukan bagaimana layanan pencarian dapat dicapai. | NetworkRuleSet |
| partitionCount | Jumlah partisi dalam layanan pencarian; jika ditentukan, bisa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya berlaku untuk SKU standar. Untuk layanan 'standar3' dengan hostingMode diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3. | int Batasan: Nilai min = 1 Nilai maks = 12 |
| publicNetworkAccess | Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang melanggar pada sumber daya dan templat pelanggan yang ada. Jika diatur ke 'dinonaktifkan', lalu lintas melalui antarmuka publik tidak diizinkan, dan koneksi titik akhir privat akan menjadi metode akses eksklusif. | 'dinonaktifkan' 'diaktifkan' |
| replicaCount | Jumlah replika dalam layanan pencarian. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar. | int Batasan: Nilai min = 1 Nilai maks = 12 |
| semanticSearch | Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU pencarian tertentu di lokasi tertentu. | 'dinonaktifkan' 'bebas' 'standar' |
DataPlaneAuthOptions
| Nama | Deskripsi | Nilai |
|---|---|---|
| aadOrApiKey | Menunjukkan bahwa kunci API atau token akses dari penyewa Microsoft Entra ID dapat digunakan untuk autentikasi. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Menunjukkan bahwa hanya kunci API yang dapat digunakan untuk autentikasi. |
DataPlaneAadOrApiKeyAuthOption
| Nama | Deskripsi | Nilai |
|---|---|---|
| aadAuthFailureMode | Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi. | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| Nama | Deskripsi | Nilai |
|---|---|---|
| Penegakan | Menjelaskan bagaimana layanan pencarian harus memberlakukan memiliki satu atau beberapa sumber daya yang tidak dienkripsi pelanggan. | 'Dinonaktifkan' 'Diaktifkan' 'Tidak ditentukan' |
NetworkRuleSet
| Nama | Deskripsi | Nilai |
|---|---|---|
| ipRules | Daftar aturan pembatasan IP yang digunakan untuk firewall IP. IP apa pun yang tidak cocok dengan aturan diblokir oleh firewall. Aturan ini hanya diterapkan ketika 'publicNetworkAccess' dari layanan pencarian 'diaktifkan'. | IpRule[] |
IpRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| nilai | Nilai yang sesuai dengan satu alamat IPv4 (misalnya, 123.1.2.3) atau rentang IP dalam format CIDR (misalnya, 123.1.2.3/24) diizinkan. | string |
SKU
| Nama | Deskripsi | Nilai |
|---|---|---|
| nama | SKU layanan pencarian. Nilai yang valid meliputi: 'gratis': Layanan bersama. 'dasar': Layanan khusus dengan hingga 3 replika. 'standar': Layanan khusus dengan hingga 12 partisi dan 12 replika. 'standard2': Mirip dengan standar, tetapi dengan kapasitas lebih per unit pencarian. 'standard3': Penawaran Standar terbesar dengan hingga 12 partisi dan 12 replika (atau hingga 3 partisi dengan lebih banyak indeks jika Anda juga mengatur properti hostingMode ke 'highDensity'). 'storage_optimized_l1': Mendukung 1 TB per partisi, hingga 12 partisi. 'storage_optimized_l2': Mendukung 2TB per partisi, hingga 12 partisi.' | 'dasar' 'bebas' 'standar' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
| Aplikasi Web dengan SQL Database, Azure Cosmos DB, Azure Search |
Templat ini menyediakan Aplikasi Web, SQL Database, Azure Cosmos DB, Azure Search, dan Application Insights. |
| Layanan Azure Cognitive Search |
Templat ini membuat layanan Azure Cognitive Search |
| layanan Azure Cognitive Search dengan titik akhir privat |
Templat ini membuat layanan Azure Cognitive Search dengan titik akhir privat. |
Definisi sumber daya Terraform (penyedia AzAPI)
Jenis sumber daya searchServices dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.Search/searchServices, tambahkan Terraform berikut ke templat Anda.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2023-11-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
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
Nilai properti
searchServices
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | "Microsoft.Search/searchServices@2023-11-01" |
| nama | Nama sumber daya | string (diperlukan) |
| lokasi | Lokasi geografis tempat sumber daya berada | string (diperlukan) |
| parent_id | Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut. | string (diperlukan) |
| tag | Tag sumber daya. | Kamus nama dan nilai tag. |
| sku | SKU layanan pencarian, yang menentukan tingkat penagihan dan batas kapasitas. Properti ini diperlukan saat membuat layanan pencarian baru. | Sku |
| identitas | Identitas sumber daya. | Identitas |
| properti | Properti layanan pencarian. | SearchServiceProperties |
Identitas
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas. | "SystemAssigned" (diperlukan) |
SearchServiceProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| authOptions | Menentukan opsi tentang bagaimana API sarana data dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true. | DataPlaneAuthOptions |
| disableLocalAuth | Ketika diatur ke true, panggilan ke layanan pencarian tidak akan diizinkan untuk menggunakan kunci API untuk autentikasi. Ini tidak dapat diatur ke true jika 'dataPlaneAuthOptions' ditentukan. | bool |
| encryptionWithCmk | Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian. | EncryptionWithCmk |
| hostingMode | Hanya berlaku untuk SKU standar3. Anda dapat mengatur properti ini untuk mengaktifkan hingga 3 partisi kepadatan tinggi yang memungkinkan hingga 1000 indeks, yang jauh lebih tinggi dari indeks maksimum yang diizinkan untuk SKU lainnya. Untuk SKU standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'. | "default" "HighDensity" |
| networkRuleSet | Aturan khusus jaringan yang menentukan bagaimana layanan pencarian dapat dicapai. | NetworkRuleSet |
| partitionCount | Jumlah partisi dalam layanan pencarian; jika ditentukan, bisa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya valid untuk SKU standar. Untuk layanan 'standar3' dengan hostingMode yang diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3. | int Batasan: Nilai min = 1 Nilai maks = 12 |
| publicNetworkAccess | Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang melanggar pada sumber daya dan templat pelanggan yang ada. Jika diatur ke 'dinonaktifkan', lalu lintas melalui antarmuka publik tidak diizinkan, dan koneksi titik akhir privat akan menjadi metode akses eksklusif. | "nonaktif" "aktif" |
| replicaCount | Jumlah replika dalam layanan pencarian. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar. | int Batasan: Nilai min = 1 Nilai maks = 12 |
| semanticSearch | Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU pencarian tertentu di lokasi tertentu. | "nonaktif" "gratis" "standar" |
DataPlaneAuthOptions
| Nama | Deskripsi | Nilai |
|---|---|---|
| aadOrApiKey | Menunjukkan bahwa kunci API atau token akses dari penyewa Microsoft Entra ID dapat digunakan untuk autentikasi. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Menunjukkan bahwa hanya kunci API yang dapat digunakan untuk autentikasi. |
DataPlaneAadOrApiKeyAuthOption
| Nama | Deskripsi | Nilai |
|---|---|---|
| aadAuthFailureMode | Menjelaskan respons apa yang akan dikirim API sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi. | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| Nama | Deskripsi | Nilai |
|---|---|---|
| Penegakan | Menjelaskan bagaimana layanan pencarian harus memberlakukan memiliki satu atau beberapa sumber daya yang tidak dienkripsi pelanggan. | "Dinonaktifkan" "Diaktifkan" "Tidak ditentukan" |
NetworkRuleSet
| Nama | Deskripsi | Nilai |
|---|---|---|
| ipRules | Daftar aturan pembatasan IP yang digunakan untuk firewall IP. IP apa pun yang tidak cocok dengan aturan diblokir oleh firewall. Aturan ini hanya diterapkan ketika 'publicNetworkAccess' dari layanan pencarian 'diaktifkan'. | IpRule[] |
IpRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| nilai | Nilai yang sesuai dengan satu alamat IPv4 (misalnya, 123.1.2.3) atau rentang IP dalam format CIDR (misalnya, 123.1.2.3/24) diizinkan. | string |
SKU
| Nama | Deskripsi | Nilai |
|---|---|---|
| nama | SKU layanan pencarian. Nilai yang valid meliputi: 'gratis': Layanan bersama. 'basic': Layanan khusus dengan hingga 3 replika. 'standar': Layanan khusus dengan hingga 12 partisi dan 12 replika. 'standard2': Mirip dengan standar, tetapi dengan kapasitas lebih per unit pencarian. 'standard3': Penawaran Standar terbesar dengan hingga 12 partisi dan 12 replika (atau hingga 3 partisi dengan lebih banyak indeks jika Anda juga mengatur properti hostingMode ke 'highDensity'). 'storage_optimized_l1': Mendukung 1 TB per partisi, hingga 12 partisi. 'storage_optimized_l2': Mendukung 2TB per partisi, hingga 12 partisi.' | "dasar" "gratis" "standar" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2" |
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk