Bagikan melalui


Services - Create Or Update

Membuat atau memperbarui layanan pencarian di grup sumber daya yang diberikan. Jika layanan pencarian sudah ada, semua properti akan diperbarui dengan nilai yang diberikan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2025-05-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.

searchServiceName
path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

Nama layanan Azure AI Search yang terkait dengan grup sumber daya yang ditentukan.

subscriptionId
path True

string (uuid)

ID langganan target. Nilainya harus sebuah UUID.

api-version
query True

string

minLength: 1

Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-request-id

string (uuid)

Nilai GUID yang dihasilkan klien yang mengidentifikasi permintaan ini. Jika ditentukan, ini akan disertakan dalam informasi respons sebagai cara untuk melacak permintaan.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
location True

string

Lokasi geografis tempat sumber daya berada

identity

Identity

Identitas sumber daya.

properties.authOptions

DataPlaneAuthOptions

Menentukan opsi tentang cara API sarana data layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.

properties.computeType

ComputeType

Konfigurasikan properti ini untuk mendukung layanan pencarian menggunakan Komputasi Default atau Komputasi Rahasia Azure.

properties.dataExfiltrationProtections

SearchDataExfiltrationProtection[]

Daftar skenario penyelundupan data yang secara eksplisit tidak diizinkan untuk layanan pencarian. Saat ini, satu-satunya nilai yang didukung adalah 'Semua' untuk menonaktifkan semua kemungkinan skenario ekspor data dengan kontrol yang lebih halus yang direncanakan untuk masa depan.

properties.disableLocalAuth

boolean

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.

properties.encryptionWithCmk

EncryptionWithCmk

Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian.

properties.endpoint

string (uri)

Titik akhir layanan Pencarian Azure AI.

properties.hostingMode

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 standard3, nilainya adalah 'Default' atau 'HighDensity'. Untuk semua SKU lainnya, nilai ini harus 'Default'.

properties.networkRuleSet

NetworkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan Azure AI Search dapat dicapai.

properties.partitionCount

integer (int32)

minimum: 1
maximum: 12

Jumlah partisi dalam layanan pencarian khusus; Jika ditentukan, itu bisa berupa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya berlaku untuk SKU standar. Untuk layanan 'standard3' dengan hostingMode yang diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3.

properties.publicNetworkAccess

PublicNetworkAccess

Nilai ini dapat diatur ke 'Diaktifkan' untuk menghindari perubahan yang rusak 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.

properties.replicaCount

integer (int32)

minimum: 1
maximum: 12

Jumlah replika dalam layanan pencarian khusus. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar.

properties.semanticSearch

SearchSemanticSearch

Menentukan ketersediaan dan paket penagihan untuk pencarian semantik di layanan Azure AI Search. Konfigurasi ini hanya tersedia untuk tingkat harga tertentu di wilayah tertentu.

properties.upgradeAvailable

UpgradeAvailable

Menunjukkan apakah layanan pencarian memiliki peningkatan yang tersedia.

sku

Sku

SKU layanan pencarian, yang menentukan tingkat harga dan batas kapasitas. Properti ini diperlukan saat membuat layanan pencarian baru.

tags

object

Tag sumber daya.

Respons

Nama Jenis Deskripsi
200 OK

SearchService

Operasi pembaruan 'SearchService' sumber daya berhasil

201 Created

SearchService

Operasi pembuatan 'SearchService' sumber daya berhasil

Header

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithDataExfiltration
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceAuthOptions

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "disableLocalAuth": true,
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": null,
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": true,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": null,
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": true,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "publicNetworkAccess": "Disabled",
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Disabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Disabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "replicaCount": 1
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "replicaCount": 1
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    },
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Enabled"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Enabled"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceWithIdentity

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  },
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateWithSemanticSearch

Permintaan sampel

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3,
    "semanticSearch": "free"
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Respon sampel

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "semanticSearch": "free",
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}
{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "semanticSearch": "free",
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Definisi

Nama Deskripsi
AadAuthFailureMode

Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi.

CloudError

Berisi informasi tentang kesalahan API.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

ComputeType

Konfigurasikan properti ini untuk mendukung layanan pencarian menggunakan Komputasi Default atau Komputasi Rahasia Azure.

createdByType

Jenis identitas yang membuat sumber daya.

DataPlaneAadOrApiKeyAuthOption

Menunjukkan bahwa kunci API atau token akses dari penyewa ID Microsoft Entra dapat digunakan untuk autentikasi.

DataPlaneAuthOptions

Menentukan opsi tentang cara layanan pencarian mengautentikasi permintaan sarana data. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.

EncryptionWithCmk

Menjelaskan kebijakan yang menentukan bagaimana sumber daya dalam layanan pencarian akan dienkripsi dengan kunci yang dikelola pelanggan.

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 standard3, nilainya adalah 'Default' atau 'HighDensity'. Untuk semua SKU lainnya, nilai ini harus 'Default'.

Identity

Detail tentang identitas layanan pencarian. Nilai null menunjukkan bahwa layanan pencarian tidak memiliki identitas yang ditetapkan.

IdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat oleh sistem dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus semua identitas dari layanan.

IpRule

Aturan pembatasan IP layanan Azure AI Search.

NetworkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan Azure AI Search dapat dicapai.

PrivateEndpointConnection

Menjelaskan koneksi titik akhir privat yang ada ke layanan Azure AI Search.

PrivateEndpointConnectionProperties

Menjelaskan properti koneksi titik akhir privat yang ada ke layanan pencarian.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Sumber daya titik akhir privat dari penyedia Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Menjelaskan status koneksi layanan Azure Private Link yang ada saat ini ke titik akhir privat.

PrivateLinkServiceConnectionProvisioningState

Status provisi koneksi layanan tautan privat. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau Dibatalkan.

PrivateLinkServiceConnectionStatus

Status koneksi layanan tautan privat. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

ProvisioningState

Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status menengah yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'Berhasil' atau 'Gagal'. Aplikasi klien dapat melakukan polling status provisi (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'Berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan.

PublicNetworkAccess

Nilai ini dapat diatur ke 'Diaktifkan' untuk menghindari perubahan yang rusak 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.

SearchBypass

Kemungkinan asal lalu lintas masuk yang dapat melewati aturan yang ditentukan di bagian 'ipRules'.

SearchDataExfiltrationProtection

Skenario eksfiltrasi data tertentu yang dinonaktifkan untuk layanan.

SearchEncryptionComplianceStatus

Mengembalikan status kepatuhan layanan pencarian sehubungan dengan objek yang tidak dienkripsi CMK. Jika layanan memiliki lebih dari satu objek yang tidak terenkripsi, dan penerapan diaktifkan, layanan ditandai sebagai tidak patuh.

SearchEncryptionWithCmk

Menjelaskan bagaimana layanan pencarian harus memberlakukan kepatuhan jika menemukan objek yang tidak dienkripsi dengan kunci yang dikelola pelanggan.

SearchSemanticSearch

Menentukan ketersediaan dan paket penagihan untuk pencarian semantik di layanan Azure AI Search. Konfigurasi ini hanya tersedia untuk tingkat harga tertentu di wilayah tertentu.

SearchService

Menjelaskan layanan Azure AI Search dan statusnya saat ini.

SearchServiceStatus

Status layanan pencarian. Nilai yang mungkin termasuk: 'berjalan': Layanan pencarian sedang berjalan dan tidak ada operasi provisi yang sedang berlangsung. 'provisi': Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya. 'menghapus': Layanan pencarian sedang dihapus. 'terdegradasi': Layanan pencarian terdegradasi. Ini dapat terjadi ketika unit pencarian yang mendasar tidak sehat. Layanan pencarian kemungkinan besar beroperasi, tetapi performa mungkin lambat dan beberapa permintaan mungkin dihilangkan. 'dinonaktifkan': Layanan pencarian dinonaktifkan. Dalam status ini, layanan akan menolak semua permintaan API. 'error': Layanan pencarian dalam status kesalahan. 'dihentikan': Layanan pencarian berada dalam langganan yang dinonaktifkan. Jika layanan Anda berada dalam status terdegradasi, dinonaktifkan, atau kesalahan, itu berarti tim Pencarian Azure AI secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.

SharedPrivateLinkResource

Menjelaskan sumber daya tautan privat bersama yang dikelola oleh layanan Pencarian Azure AI.

SharedPrivateLinkResourceProperties

Menjelaskan properti sumber daya tautan privat bersama yang sudah ada yang dikelola oleh layanan Azure AI Search.

SharedPrivateLinkResourceProvisioningState

Status provisi sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

Sku

Menentukan SKU layanan pencarian, yang menentukan tingkat penagihan dan batas kapasitas.

SkuName

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 lebih banyak kapasitas 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. 'tanpa server': Tingkat tanpa server dengan kemampuan penskalaan otomatis.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

UpgradeAvailable

Menunjukkan apakah layanan pencarian khusus memiliki peningkatan yang tersedia.

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

AadAuthFailureMode

Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi.

Nilai Deskripsi
http403

Menunjukkan bahwa permintaan bahwa autentikasi yang gagal harus disajikan dengan kode status HTTP 403 (Terlarang).

http401WithBearerChallenge

Menunjukkan bahwa permintaan bahwa autentikasi yang gagal harus disajikan dengan kode status HTTP 401 (Tidak Sah) dan menyajikan Tantangan Pembawa.

CloudError

Berisi informasi tentang kesalahan API.

Nama Jenis Deskripsi
error

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

message

string

Deskripsi singkat tentang kesalahan yang mengisyaratkan apa yang salah (untuk informasi detail/penelusuran kesalahan merujuk ke properti 'error.message').

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama Jenis Deskripsi
code

string

Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.

details

CloudErrorBody[]

Berisi kesalahan berlapis yang terkait dengan kesalahan ini.

message

string

Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.

target

string

Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

ComputeType

Konfigurasikan properti ini untuk mendukung layanan pencarian menggunakan Komputasi Default atau Komputasi Rahasia Azure.

Nilai Deskripsi
Default

Buat layanan dengan Komputasi Default.

Confidential

Buat layanan khusus dengan Azure Confidential Compute.

createdByType

Jenis identitas yang membuat sumber daya.

Nilai Deskripsi
User
Application
ManagedIdentity
Key

DataPlaneAadOrApiKeyAuthOption

Menunjukkan bahwa kunci API atau token akses dari penyewa ID Microsoft Entra dapat digunakan untuk autentikasi.

Nama Jenis Deskripsi
aadAuthFailureMode

AadAuthFailureMode

Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi.

DataPlaneAuthOptions

Menentukan opsi tentang cara layanan pencarian mengautentikasi permintaan sarana data. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.

Nama Jenis Deskripsi
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Menunjukkan bahwa kunci API atau token akses dari penyewa ID Microsoft Entra dapat digunakan untuk autentikasi.

apiKeyOnly

Menunjukkan bahwa hanya kunci API yang dapat digunakan untuk autentikasi.

EncryptionWithCmk

Menjelaskan kebijakan yang menentukan bagaimana sumber daya dalam layanan pencarian akan dienkripsi dengan kunci yang dikelola pelanggan.

Nama Jenis Deskripsi
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Mengembalikan status kepatuhan layanan pencarian sehubungan dengan objek yang tidak dienkripsi CMK. Jika layanan memiliki lebih dari satu objek yang tidak terenkripsi, dan penerapan diaktifkan, layanan ditandai sebagai tidak patuh.

enforcement

SearchEncryptionWithCmk

Menjelaskan bagaimana layanan pencarian harus memberlakukan kepatuhan jika menemukan objek yang tidak dienkripsi dengan kunci yang dikelola pelanggan.

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 standard3, nilainya adalah 'Default' atau 'HighDensity'. Untuk semua SKU lainnya, nilai ini harus 'Default'.

Nilai Deskripsi
Default

Batas maksimum indeks ditentukan oleh SKU atau tingkat harga.

HighDensity

Hanya berlaku untuk SKU Standard3 (S3), di mana layanan penelusuran dapat memiliki hingga 1.000 indeks.

Identity

Detail tentang identitas layanan pencarian. Nilai null menunjukkan bahwa layanan pencarian tidak memiliki identitas yang ditetapkan.

Nama Jenis Deskripsi
principalId

string

ID utama identitas layanan pencarian yang ditetapkan sistem.

tenantId

string

ID penyewa dari identitas layanan pencarian yang ditetapkan sistem.

type

IdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat oleh sistem dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus semua identitas dari layanan.

userAssignedIdentities

<string,  UserAssignedIdentity>

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan berupa ID sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat oleh sistem dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus semua identitas dari layanan.

Nilai Deskripsi
None

Menunjukkan bahwa identitas apa pun yang terkait dengan layanan pencarian perlu dihapus.

SystemAssigned

Menunjukkan bahwa identitas yang ditetapkan sistem untuk layanan pencarian akan diaktifkan.

UserAssigned

Menunjukkan bahwa satu atau beberapa identitas yang ditetapkan pengguna akan ditetapkan ke layanan pencarian.

SystemAssigned, UserAssigned

Menunjukkan bahwa identitas yang ditetapkan sistem untuk layanan pencarian akan diaktifkan bersama dengan penetapan satu atau beberapa identitas yang ditetapkan pengguna.

IpRule

Aturan pembatasan IP layanan Azure AI Search.

Nama Jenis Deskripsi
value

string

Nilai yang sesuai dengan satu alamat IPv4 (misalnya, 123.1.2.3) atau rentang IP dalam format CIDR (misalnya, 123.1.2.3/24) untuk diizinkan.

NetworkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan Azure AI Search dapat dicapai.

Nama Jenis Deskripsi
bypass

SearchBypass

Kemungkinan asal lalu lintas masuk yang dapat melewati aturan yang ditentukan di bagian 'ipRules'.

ipRules

IpRule[]

Daftar aturan pembatasan IP yang menentukan jaringan masuk dengan mengizinkan akses ke titik akhir layanan pencarian. Sementara itu, semua jaringan IP publik lainnya diblokir oleh firewall. Aturan pembatasan ini hanya diterapkan ketika 'publicNetworkAccess' dari layanan pencarian 'diaktifkan'; jika tidak, lalu lintas melalui antarmuka publik tidak diizinkan bahkan dengan aturan IP publik apa pun, dan koneksi titik akhir privat akan menjadi metode akses eksklusif.

PrivateEndpointConnection

Menjelaskan koneksi titik akhir privat yang ada ke layanan Azure AI Search.

Nama Jenis Deskripsi
id

string (arm-id)

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nama sumber daya

properties

PrivateEndpointConnectionProperties

Menjelaskan properti koneksi titik akhir privat yang ada ke layanan Azure AI Search.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Menjelaskan properti koneksi titik akhir privat yang ada ke layanan pencarian.

Nama Jenis Deskripsi
groupId

string

ID grup sumber daya Azure tempat layanan tautan privat berada.

privateEndpoint

PrivateEndpointConnectionPropertiesPrivateEndpoint

Sumber daya titik akhir privat dari penyedia Microsoft.Network.

privateLinkServiceConnectionState

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Menjelaskan status koneksi layanan Azure Private Link yang ada saat ini ke titik akhir privat.

provisioningState

PrivateLinkServiceConnectionProvisioningState

Status provisi koneksi layanan tautan privat. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau Dibatalkan.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Sumber daya titik akhir privat dari penyedia Microsoft.Network.

Nama Jenis Deskripsi
id

string

ID sumber daya sumber daya titik akhir privat dari penyedia Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Menjelaskan status koneksi layanan Azure Private Link yang ada saat ini ke titik akhir privat.

Nama Jenis Nilai default Deskripsi
actionsRequired

string

None

Deskripsi tindakan tambahan apa pun yang mungkin diperlukan.

description

string

Deskripsi untuk status koneksi layanan tautan privat.

status

PrivateLinkServiceConnectionStatus

Status koneksi layanan tautan privat. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

PrivateLinkServiceConnectionProvisioningState

Status provisi koneksi layanan tautan privat. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau Dibatalkan.

Nilai Deskripsi
Updating

Koneksi layanan tautan privat sedang dalam proses dibuat bersama dengan sumber daya lain agar berfungsi penuh.

Deleting

Koneksi layanan tautan privat sedang dalam proses dihapus.

Failed

Koneksi layanan tautan privat gagal disediakan atau dihapus.

Succeeded

Koneksi layanan tautan privat telah selesai menyediakan dan siap untuk disetujui.

Incomplete

Permintaan provisi untuk sumber daya koneksi layanan tautan privat telah diterima tetapi proses pembuatan belum dimulai.

Canceled

Permintaan provisi untuk sumber daya koneksi layanan tautan privat telah dibatalkan.

PrivateLinkServiceConnectionStatus

Status koneksi layanan tautan privat. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

Nilai Deskripsi
Pending

Koneksi titik akhir privat telah dibuat dan menunggu persetujuan.

Approved

Koneksi titik akhir privat disetujui dan siap digunakan.

Rejected

Koneksi titik akhir privat telah ditolak dan tidak dapat digunakan.

Disconnected

Koneksi titik akhir privat telah dihapus dari layanan.

ProvisioningState

Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status menengah yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'Berhasil' atau 'Gagal'. Aplikasi klien dapat melakukan polling status provisi (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'Berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan.

Nilai Deskripsi
succeeded

Operasi provisi terakhir telah berhasil diselesaikan.

provisioning

Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya. Hanya untuk layanan pencarian khusus.

failed

Operasi provisi terakhir gagal.

PublicNetworkAccess

Nilai ini dapat diatur ke 'Diaktifkan' untuk menghindari perubahan yang rusak 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.

Nilai Deskripsi
Enabled

Layanan pencarian dapat diakses dari lalu lintas yang berasal dari internet publik.

Disabled

Layanan pencarian tidak dapat diakses dari lalu lintas yang berasal dari internet publik. Akses hanya diizinkan melalui koneksi titik akhir privat yang disetujui.

SecuredByPerimeter

Aturan konfigurasi perimeter keamanan jaringan mengizinkan atau tidak mengizinkan akses jaringan publik ke sumber daya. Memerlukan perimeter keamanan jaringan terkait.

SearchBypass

Kemungkinan asal lalu lintas masuk yang dapat melewati aturan yang ditentukan di bagian 'ipRules'.

Nilai Deskripsi
None

Menunjukkan bahwa tidak ada asal yang dapat melewati aturan yang ditentukan di bagian 'ipRules'. Ini adalah default.

AzureServices

Menunjukkan bahwa permintaan yang berasal dari layanan tepercaya Azure dapat melewati aturan yang ditentukan di bagian 'ipRules'.

SearchDataExfiltrationProtection

Skenario eksfiltrasi data tertentu yang dinonaktifkan untuk layanan.

Nilai Deskripsi
BlockAll

Menunjukkan bahwa semua skenario penyelundupan data dinonaktifkan.

SearchEncryptionComplianceStatus

Mengembalikan status kepatuhan layanan pencarian sehubungan dengan objek yang tidak dienkripsi CMK. Jika layanan memiliki lebih dari satu objek yang tidak terenkripsi, dan penerapan diaktifkan, layanan ditandai sebagai tidak patuh.

Nilai Deskripsi
Compliant

Menunjukkan bahwa layanan pencarian sesuai, baik karena jumlah objek yang tidak dienkripsi CMK adalah nol atau penerapan dinonaktifkan.

NonCompliant

Menunjukkan bahwa layanan pencarian memiliki lebih dari satu objek yang tidak dienkripsi CMK.

SearchEncryptionWithCmk

Menjelaskan bagaimana layanan pencarian harus memberlakukan kepatuhan jika menemukan objek yang tidak dienkripsi dengan kunci yang dikelola pelanggan.

Nilai Deskripsi
Disabled

Tidak ada penegakan enkripsi kunci yang dikelola pelanggan yang akan dilakukan. Hanya enkripsi terkelola layanan bawaan yang digunakan.

Enabled

Layanan pencarian akan ditandai sebagai tidak patuh jika satu atau beberapa objek tidak dienkripsi dengan kunci yang dikelola pelanggan.

Unspecified

Kebijakan penegakan tidak ditentukan secara eksplisit, dengan perilaku yang sama seolah-olah diatur ke 'Dinonaktifkan'.

SearchSemanticSearch

Menentukan ketersediaan dan paket penagihan untuk pencarian semantik di layanan Azure AI Search. Konfigurasi ini hanya tersedia untuk tingkat harga tertentu di wilayah tertentu.

Nilai Deskripsi
disabled

Menunjukkan bahwa reranker semantik dinonaktifkan untuk layanan pencarian.

free

Memungkinkan reranker semantik pada layanan pencarian dan menunjukkan bahwa itu akan digunakan dalam batas paket gratis. Paket gratis akan menutup volume permintaan peringkat semantik dan ditawarkan tanpa biaya tambahan. Ini adalah default untuk layanan pencarian yang baru disediakan. Ini adalah default.

standard

Mengaktifkan reranker semantik pada layanan penelusuran sebagai fitur yang dapat ditagih setelah kuota gratis habis, dengan throughput dan volume kueri yang diberi peringkat ulang semantik yang lebih tinggi.

SearchService

Menjelaskan layanan Azure AI Search dan statusnya saat ini.

Nama Jenis Nilai default Deskripsi
id

string (arm-id)

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

Identity

Identitas sumber daya.

location

string

Lokasi geografis tempat sumber daya berada

name

string

Nama sumber daya

properties.authOptions

DataPlaneAuthOptions

Menentukan opsi tentang cara API sarana data layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.

properties.computeType

ComputeType

Konfigurasikan properti ini untuk mendukung layanan pencarian menggunakan Komputasi Default atau Komputasi Rahasia Azure.

properties.dataExfiltrationProtections

SearchDataExfiltrationProtection[]

Daftar skenario penyelundupan data yang secara eksplisit tidak diizinkan untuk layanan pencarian. Saat ini, satu-satunya nilai yang didukung adalah 'Semua' untuk menonaktifkan semua kemungkinan skenario ekspor data dengan kontrol yang lebih halus yang direncanakan untuk masa depan.

properties.disableLocalAuth

boolean

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.

properties.eTag

string

Properti yang dihasilkan sistem yang mewakili etag layanan yang dapat untuk kontrol konkurensi optimis selama pembaruan.

properties.encryptionWithCmk

EncryptionWithCmk

Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian.

properties.endpoint

string (uri)

Titik akhir layanan Pencarian Azure AI.

properties.hostingMode

HostingMode

Default

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 standard3, nilainya adalah 'Default' atau 'HighDensity'. Untuk semua SKU lainnya, nilai ini harus 'Default'.

properties.networkRuleSet

NetworkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan Azure AI Search dapat dicapai.

properties.partitionCount

integer (int32)

minimum: 1
maximum: 12
1

Jumlah partisi dalam layanan pencarian khusus; Jika ditentukan, itu bisa berupa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya berlaku untuk SKU standar. Untuk layanan 'standard3' dengan hostingMode yang diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Daftar koneksi titik akhir privat ke layanan Pencarian Azure AI.

properties.provisioningState

ProvisioningState

Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status menengah yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'Berhasil' atau 'Gagal'. Aplikasi klien dapat melakukan polling status provisi (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'Berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Nilai ini dapat diatur ke 'Diaktifkan' untuk menghindari perubahan yang rusak 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.

properties.replicaCount

integer (int32)

minimum: 1
maximum: 12
1

Jumlah replika dalam layanan pencarian khusus. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar.

properties.semanticSearch

SearchSemanticSearch

Menentukan ketersediaan dan paket penagihan untuk pencarian semantik di layanan Azure AI Search. Konfigurasi ini hanya tersedia untuk tingkat harga tertentu di wilayah tertentu.

properties.serviceUpgradedAt

string (date-time)

Tanggal dan waktu layanan pencarian terakhir kali dimutakhirkan. Bidang ini akan null hingga layanan ditingkatkan untuk pertama kalinya.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Daftar sumber daya tautan privat bersama yang dikelola oleh layanan Pencarian Azure AI.

properties.status

SearchServiceStatus

Status layanan pencarian. Nilai yang mungkin termasuk: 'berjalan': Layanan pencarian sedang berjalan dan tidak ada operasi provisi yang sedang berlangsung. 'provisi': Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya. 'menghapus': Layanan pencarian sedang dihapus. 'terdegradasi': Layanan pencarian terdegradasi. Ini dapat terjadi ketika unit pencarian yang mendasar tidak sehat. Layanan pencarian kemungkinan besar beroperasi, tetapi performa mungkin lambat dan beberapa permintaan mungkin dihilangkan. 'dinonaktifkan': Layanan pencarian dinonaktifkan. Dalam status ini, layanan akan menolak semua permintaan API. 'error': Layanan pencarian dalam status kesalahan. 'dihentikan': Layanan pencarian berada dalam langganan yang dinonaktifkan. Jika layanan Anda berada dalam status terdegradasi, dinonaktifkan, atau kesalahan, itu berarti tim Pencarian Azure AI secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.

properties.statusDetails

string

Detail status layanan pencarian.

properties.upgradeAvailable

UpgradeAvailable

Menunjukkan apakah layanan pencarian memiliki peningkatan yang tersedia.

sku

Sku

SKU layanan pencarian, yang menentukan tingkat harga dan batas kapasitas. Properti ini diperlukan saat membuat layanan pencarian baru.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Status layanan pencarian. Nilai yang mungkin termasuk: 'berjalan': Layanan pencarian sedang berjalan dan tidak ada operasi provisi yang sedang berlangsung. 'provisi': Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya. 'menghapus': Layanan pencarian sedang dihapus. 'terdegradasi': Layanan pencarian terdegradasi. Ini dapat terjadi ketika unit pencarian yang mendasar tidak sehat. Layanan pencarian kemungkinan besar beroperasi, tetapi performa mungkin lambat dan beberapa permintaan mungkin dihilangkan. 'dinonaktifkan': Layanan pencarian dinonaktifkan. Dalam status ini, layanan akan menolak semua permintaan API. 'error': Layanan pencarian dalam status kesalahan. 'dihentikan': Layanan pencarian berada dalam langganan yang dinonaktifkan. Jika layanan Anda berada dalam status terdegradasi, dinonaktifkan, atau kesalahan, itu berarti tim Pencarian Azure AI secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.

Nilai Deskripsi
running

Layanan pencarian berjalan dan tidak ada operasi provisi yang sedang berlangsung.

provisioning

Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya.

deleting

Layanan pencarian sedang dihapus.

degraded

Layanan pencarian terdegradasi karena unit pencarian yang mendasar tidak sehat.

disabled

Layanan pencarian dinonaktifkan dan semua permintaan API akan ditolak.

error

Layanan pencarian dalam status kesalahan, menunjukkan kegagalan provisi atau dihapus.

stopped

Layanan pencarian berada dalam langganan yang dinonaktifkan.

SharedPrivateLinkResource

Menjelaskan sumber daya tautan privat bersama yang dikelola oleh layanan Pencarian Azure AI.

Nama Jenis Deskripsi
id

string (arm-id)

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nama sumber daya

properties

SharedPrivateLinkResourceProperties

Menjelaskan properti sumber daya tautan privat bersama yang dikelola oleh layanan Pencarian Azure AI.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Menjelaskan properti sumber daya tautan privat bersama yang sudah ada yang dikelola oleh layanan Azure AI Search.

Nama Jenis Deskripsi
groupId

string

ID grup dari penyedia sumber daya yang digunakan untuk sumber daya tautan privat bersama.

privateLinkResourceId

string

ID sumber daya sumber daya untuk sumber daya tautan privat bersama adalah untuk.

provisioningState

SharedPrivateLinkResourceProvisioningState

Status provisi sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.

requestMessage

string

Pesan untuk meminta persetujuan sumber daya tautan privat bersama.

resourceRegion

string

Fakultatif. Dapat digunakan untuk menentukan lokasi Azure Resource Manager sumber daya tempat tautan privat bersama dibuat. Ini hanya diperlukan untuk sumber daya yang konfigurasi DNS-nya regional (seperti Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

SharedPrivateLinkResourceProvisioningState

Status provisi sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.

Nilai Deskripsi
Updating

Sumber daya tautan privat bersama sedang dalam proses dibuat bersama dengan sumber daya lain agar berfungsi penuh.

Deleting

Sumber daya tautan privat bersama sedang dalam proses dihapus.

Failed

Sumber daya tautan privat bersama gagal disediakan atau dihapus.

Succeeded

Sumber daya tautan privat bersama telah selesai menyediakan dan siap untuk disetujui.

Incomplete

Permintaan provisi untuk sumber daya tautan privat bersama telah diterima tetapi proses pembuatan belum dimulai.

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

Nilai Deskripsi
Pending

Sumber daya tautan privat bersama telah dibuat dan menunggu persetujuan.

Approved

Sumber daya tautan privat bersama disetujui dan siap digunakan.

Rejected

Sumber daya tautan privat bersama telah ditolak dan tidak dapat digunakan.

Disconnected

Sumber daya tautan privat bersama telah dihapus dari layanan.

Sku

Menentukan SKU layanan pencarian, yang menentukan tingkat penagihan dan batas kapasitas.

Nama Jenis Deskripsi
name

SkuName

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 lebih banyak kapasitas 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. 'tanpa server': Tingkat tanpa server dengan kemampuan penskalaan otomatis.

SkuName

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 lebih banyak kapasitas 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. 'tanpa server': Tingkat tanpa server dengan kemampuan penskalaan otomatis.

Nilai Deskripsi
free

Tingkat gratis, tanpa jaminan SLA dan subset fitur yang ditawarkan pada tingkat yang dapat ditagih.

basic

Tingkat yang dapat ditagih untuk layanan khusus yang memiliki hingga 3 replika.

standard

Tingkat yang dapat ditagih untuk layanan khusus yang memiliki hingga 12 partisi dan 12 replika.

standard2

Mirip dengan 'standar', tetapi dengan lebih banyak kapasitas 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

Tingkat yang dapat ditagih untuk layanan khusus yang mendukung 1TB per partisi, hingga 12 partisi.

storage_optimized_l2

Tingkat yang dapat ditagih untuk layanan khusus yang mendukung 2TB per partisi, hingga 12 partisi.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string (date-time)

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string (date-time)

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir memodifikasi sumber daya.

UpgradeAvailable

Menunjukkan apakah layanan pencarian khusus memiliki peningkatan yang tersedia.

Nilai Deskripsi
notAvailable

Peningkatan saat ini tidak tersedia untuk layanan khusus.

available

Ada peningkatan yang tersedia untuk layanan khusus.

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

Nama Jenis Deskripsi
clientId

string (uuid)

ID klien dari identitas yang ditetapkan.

principalId

string (uuid)

ID utama identitas yang ditetapkan.