Services - Create Or Update

Service:

Search Management

API Version:

2021-04-01-preview

Membuat atau memperbarui layanan pencarian di grup sumber daya tertentu. 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=2021-04-01-preview

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan saat ini. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
searchServiceName	path	True	string	Nama layanan Azure Cognitive Search untuk dibuat atau diperbarui. layanan Pencarian nama hanya boleh berisi huruf kecil, digit atau tanda hubung, tidak dapat menggunakan tanda hubung sebagai dua karakter pertama atau terakhir, tidak boleh berisi tanda hubung berturut-turut, dan panjangnya harus antara 2 dan 60 karakter. nama layanan Pencarian harus unik secara global karena merupakan bagian dari URI layanan (https://.search.windows.net). Anda tidak dapat mengubah nama layanan setelah layanan dibuat.
subscriptionId	path	True	string	Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
api-version	query	True	string	Versi API yang digunakan untuk setiap permintaan.

Header Permintaan

Name	Required	Type	Description
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

Name	Required	Type	Description
location	True	string	Lokasi geografis tempat sumber daya berada
identity		Identity	Identitas sumber daya.
properties.authOptions		DataPlaneAuthOptions	Menentukan opsi tentang bagaimana API sarana data dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.
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.disabledDataExfiltrationOptions		string[]	Daftar skenario penyelundupan data yang secara eksplisit tidak diizinkan untuk layanan pencarian. Saat ini, satu-satunya nilai yang didukung adalah 'Semua' untuk menonaktifkan semua skenario ekspor data yang mungkin dengan kontrol yang lebih halus yang direncanakan untuk masa depan.
properties.encryptionWithCmk		EncryptionWithCmk	Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian.
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 standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'.
properties.networkRuleSet		NetworkRuleSet	Aturan khusus jaringan yang menentukan bagaimana layanan Azure Cognitive Search dapat dicapai.
properties.partitionCount		integer	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.
properties.publicNetworkAccess		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.
properties.replicaCount		integer	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.
properties.semanticSearch		SearchSemanticSearch	Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU Azure Cognitive Search tertentu di lokasi tertentu.
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

Name	Type	Description
200 OK	SearchService	Definisi layanan yang ada berhasil diperbarui. Jika Anda mengubah jumlah replika atau partisi, operasi skala akan terjadi secara asinkron. Anda dapat secara berkala mendapatkan definisi layanan Anda dan memantau kemajuan melalui properti provisioningState.
201 Created	SearchService	Jika Anda meminta pembuatan layanan pencarian gratis, layanan sekarang disediakan dan siap digunakan, tunduk pada penundaan penyebaran DNS. Untuk jenis SKU lainnya, provisi terjadi secara asinkron. Anda dapat secara berkala mendapatkan definisi layanan Anda dan memantau kemajuan melalui properti provisioningState.
Other Status Codes	CloudError	HTTP 400 (Permintaan Buruk): Nama layanan atau definisi layanan yang diberikan tidak valid; Lihat kode kesalahan dan pesan dalam respons untuk detailnya. HTTP 404 (Tidak Ditemukan): Langganan atau grup sumber daya tidak dapat ditemukan. HTTP 409 (Konflik): Langganan yang ditentukan dinonaktifkan.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

SearchCreateOrUpdateService

SearchCreateOrUpdateServiceAuthOptions

SearchCreateOrUpdateServiceDisableLocalAuth

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchCreateOrUpdateServiceWithCmkEnforcement

SearchCreateOrUpdateServiceWithDataExfiltration

SearchCreateOrUpdateServiceWithIdentity

SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceAuthOptions

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

SearchCreateOrUpdateServiceWithIdentity

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "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"
      }
    }
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "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"
      }
    }
  }
}

SearchCreateOrUpdateWithSemanticSearch

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}

Definisi

AadAuthFailureMode	Menjelaskan respons apa yang akan dikirim api bidang data dari layanan Pencarian untuk permintaan autentikasi yang gagal.
ApiKeyOnly	Menunjukkan bahwa hanya kunci API yang perlu digunakan untuk autentikasi.
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
DataPlaneAadOrApiKeyAuthOption	Menunjukkan bahwa kunci API atau token akses dari Azure Active Directory dapat digunakan untuk autentikasi.
DataPlaneAuthOptions	Menentukan opsi tentang cara API sarana data dari layanan Pencarian mengautentikasi permintaan. 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 standar3, 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 satu set identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus semua identitas dari layanan.
IpRule	Aturan pembatasan IP dari layanan Azure Cognitive Search.
NetworkRuleSet	Aturan khusus jaringan yang menentukan bagaimana layanan Azure Cognitive Search dapat dicapai.
PrivateEndpoint	Sumber daya titik akhir privat dari penyedia Microsoft.Network.
PrivateEndpointConnection	Menjelaskan koneksi Titik Akhir Privat yang ada ke layanan Azure Cognitive Search.
PrivateEndpointConnectionProperties	Menjelaskan properti koneksi Titik Akhir Privat yang ada ke layanan Azure Cognitive Search.
PrivateLinkServiceConnectionState	Menjelaskan status koneksi Layanan Private Link yang ada saat ini ke Titik Akhir Privat Azure.
PrivateLinkServiceConnectionStatus	Status koneksi layanan tautan privat. Bisa 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 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.
SearchBypass	Kemungkinan asal lalu lintas masuk yang dapat melewati aturan yang ditentukan di bagian 'ipRules'.
SearchEncryptionComplianceStatus	Menjelaskan apakah layanan pencarian sesuai atau tidak sehubungan dengan memiliki sumber daya yang tidak dienkripsi pelanggan. Jika layanan memiliki lebih dari satu sumber daya terenkripsi non pelanggan dan 'Penegakan' 'diaktifkan' maka layanan akan ditandai sebagai 'nonCompliant'.
SearchEncryptionWithCmk	Menjelaskan bagaimana layanan pencarian harus memberlakukan memiliki satu atau beberapa sumber daya yang tidak dienkripsi pelanggan.
SearchSemanticSearch	Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU Azure Cognitive Search tertentu di lokasi tertentu.
SearchService	Menjelaskan layanan Azure Cognitive 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 Azure Cognitive Search secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.
SharedPrivateLinkResource	Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.
SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan Azure Cognitive Search.
SharedPrivateLinkResourceProvisioningState	Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau nilai lain yang belum di dokumentasikan.
SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, Terputus, atau nilai lain yang belum di dokumentasikan.
Sku	Mendefinisikan SKU layanan Azure Cognitive Search, yang menentukan tingkat harga dan batas kapasitas.
SkuName	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.'
UserAssignedManagedIdentity	Detail identitas terkelola yang ditetapkan pengguna yang ditetapkan ke layanan pencarian.

AadAuthFailureMode

Menjelaskan respons apa yang akan dikirim api bidang data dari layanan Pencarian untuk permintaan autentikasi yang gagal.

Name	Type	Description
http401WithBearerChallenge	string	Menunjukkan bahwa permintaan bahwa autentikasi yang gagal harus disajikan dengan kode status HTTP 401 (Tidak Sah) dan menyajikan Tantangan Pembawa.
http403	string	Menunjukkan bahwa permintaan bahwa autentikasi yang gagal harus disajikan dengan kode status HTTP 403 (Terlarang).

ApiKeyOnly

Menunjukkan bahwa hanya kunci API yang perlu digunakan untuk autentikasi.

CloudError

Berisi informasi tentang kesalahan API.

Name	Type	Description
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
message	string	Deskripsi singkat tentang kesalahan yang mengisyaratkan apa yang salah (untuk detail/informasi penelusuran kesalahan, lihat properti 'error.message').

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Name	Type	Description
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).

DataPlaneAadOrApiKeyAuthOption

Menunjukkan bahwa kunci API atau token akses dari Azure Active Directory dapat digunakan untuk autentikasi.

Name	Type	Description
aadAuthFailureMode	AadAuthFailureMode	Menjelaskan respons apa yang akan dikirim api bidang data dari layanan Pencarian untuk permintaan autentikasi yang gagal.

DataPlaneAuthOptions

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

Name	Type	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Menunjukkan bahwa kunci API atau token akses dari Azure Active Directory dapat digunakan untuk autentikasi.
apiKeyOnly	ApiKeyOnly	Menunjukkan bahwa hanya kunci API yang perlu digunakan untuk autentikasi.

EncryptionWithCmk

Menjelaskan kebijakan yang menentukan bagaimana sumber daya dalam layanan pencarian akan dienkripsi dengan Kunci yang Dikelola Pelanggan.

Name	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Menjelaskan apakah layanan pencarian sesuai atau tidak sehubungan dengan memiliki sumber daya yang tidak dienkripsi pelanggan. Jika layanan memiliki lebih dari satu sumber daya terenkripsi non pelanggan dan 'Penegakan' 'diaktifkan' maka layanan akan ditandai sebagai 'nonCompliant'.
enforcement	SearchEncryptionWithCmk	Menjelaskan bagaimana layanan pencarian harus memberlakukan memiliki satu atau beberapa sumber daya yang tidak dienkripsi 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 standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'.

Name	Type	Description
default	string	Batas jumlah indeks ditentukan oleh batas default untuk SKU.
highDensity	string	Hanya aplikasi untuk SKU standar3, di mana layanan pencarian dapat memiliki hingga 1000 indeks.

Identity

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

Name	Type	Description
principalId	string	ID utama identitas yang ditetapkan sistem dari layanan pencarian.
tenantId	string	ID penyewa dari identitas yang ditetapkan sistem dari layanan pencarian.
type	IdentityType	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat oleh sistem dan satu set identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus semua identitas dari layanan.
userAssignedIdentities	<string,  UserAssignedManagedIdentity>	Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi 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 satu set identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus semua identitas dari layanan.

Name	Type	Description
None	string	Menunjukkan bahwa identitas apa pun yang terkait dengan layanan pencarian perlu dihapus.
SystemAssigned	string	Menunjukkan bahwa identitas yang ditetapkan sistem untuk layanan pencarian akan diaktifkan.
SystemAssigned, UserAssigned	string	Menunjukkan bahwa identitas yang ditetapkan sistem untuk layanan pencarian akan diaktifkan bersama dengan penetapan satu atau beberapa identitas yang ditetapkan pengguna.
UserAssigned	string	Menunjukkan bahwa satu atau beberapa identitas yang ditetapkan pengguna akan ditetapkan ke layanan pencarian.

IpRule

Aturan pembatasan IP dari layanan Azure Cognitive Search.

Name	Type	Description
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 Cognitive Search dapat dicapai.

Name	Type	Description
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.

PrivateEndpoint

Sumber daya titik akhir privat dari penyedia Microsoft.Network.

Name	Type	Description
id	string	Id sumber daya sumber daya sumber daya titik akhir privat dari penyedia Microsoft.Network.

PrivateEndpointConnection

Menjelaskan koneksi Titik Akhir Privat yang ada ke layanan Azure Cognitive Search.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /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 Cognitive Search.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

PrivateEndpointConnectionProperties

Menjelaskan properti koneksi Titik Akhir Privat yang ada ke layanan Azure Cognitive Search.

Name	Type	Description
privateEndpoint	PrivateEndpoint	Sumber daya titik akhir privat dari penyedia Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Menjelaskan status koneksi Layanan Private Link yang ada saat ini ke Titik Akhir Privat Azure.

PrivateLinkServiceConnectionState

Menjelaskan status koneksi Layanan Private Link yang ada saat ini ke Titik Akhir Privat Azure.

Name	Type	Default Value	Description
actionsRequired	string	None	Deskripsi tindakan tambahan yang mungkin diperlukan.
description	string		Deskripsi untuk status koneksi layanan tautan privat.
status	PrivateLinkServiceConnectionStatus		Status koneksi layanan tautan privat. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.

PrivateLinkServiceConnectionStatus

Status koneksi layanan tautan privat. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.

Name	Type	Description
Approved	string	Koneksi titik akhir privat disetujui dan siap digunakan.
Disconnected	string	Koneksi titik akhir privat telah dihapus dari layanan.
Pending	string	Koneksi titik akhir privat telah dibuat dan menunggu persetujuan.
Rejected	string	Koneksi titik akhir privat telah ditolak dan tidak dapat digunakan.

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.

Name	Type	Description
failed	string	Operasi provisi terakhir gagal.
provisioning	string	Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya.
succeeded	string	Operasi provisi terakhir telah berhasil diselesaikan.

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.

Name	Type	Description
disabled	string	Layanan pencarian tidak dapat diakses dari lalu lintas yang berasal dari internet publik. Akses hanya diizinkan melalui koneksi titik akhir privat yang disetujui.
enabled	string	Layanan pencarian dapat diakses dari lalu lintas yang berasal dari internet publik.

SearchBypass

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

Name	Type	Description
AzurePortal	string	Menunjukkan bahwa permintaan yang berasal dari portal Azure dapat melewati aturan yang ditentukan di bagian 'ipRules'.
None	string	Menunjukkan bahwa tidak ada asal yang dapat melewati aturan yang ditentukan di bagian 'ipRules'. Ini adalah default.

SearchEncryptionComplianceStatus

Menjelaskan apakah layanan pencarian sesuai atau tidak sehubungan dengan memiliki sumber daya yang tidak dienkripsi pelanggan. Jika layanan memiliki lebih dari satu sumber daya terenkripsi non pelanggan dan 'Penegakan' 'diaktifkan' maka layanan akan ditandai sebagai 'nonCompliant'.

Name	Type	Description
Compliant	string	Menunjukkan bahwa layanan pencarian sesuai, baik karena jumlah sumber daya yang tidak dienkripsi pelanggan adalah nol atau penegakan dinonaktifkan.
NonCompliant	string	Menunjukkan bahwa layanan pencarian memiliki lebih dari 1 sumber daya yang tidak dienkripsi pelanggan.

SearchEncryptionWithCmk

Menjelaskan bagaimana layanan pencarian harus memberlakukan memiliki satu atau beberapa sumber daya yang tidak dienkripsi pelanggan.

Name	Type	Description
Disabled	string	Tidak ada penegakan yang akan dilakukan dan layanan pencarian dapat memiliki sumber daya yang tidak dienkripsi pelanggan.
Enabled	string	layanan Pencarian akan ditandai sebagai tidak patuh jika ada satu atau beberapa sumber daya yang tidak dienkripsi pelanggan.
Unspecified	string	Kebijakan penegakan tidak ditentukan secara eksplisit, dengan perilaku yang sama seolah-olah diatur ke 'Dinonaktifkan'.

SearchSemanticSearch

Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU Azure Cognitive Search tertentu di lokasi tertentu.

Name	Type	Description
disabled	string	Menunjukkan bahwa pencarian semantik dinonaktifkan untuk layanan pencarian. Ini adalah default.
free	string	Memungkinkan pencarian semantik pada layanan pencarian dan menunjukkan bahwa itu akan digunakan dalam batas tingkat gratis. Ini akan membatasi volume permintaan pencarian semantik dan ditawarkan tanpa biaya tambahan.
standard	string	Memungkinkan pencarian semantik pada layanan pencarian sebagai fitur yang dapat ditagih, dengan throughput dan volume kueri pencarian semantik yang lebih tinggi.

SearchService

Menjelaskan layanan Azure Cognitive Search dan statusnya saat ini.

Name	Type	Default Value	Description
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /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 dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.
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.disabledDataExfiltrationOptions	string[]		Daftar skenario penyelundupan data yang secara eksplisit tidak diizinkan untuk layanan pencarian. Saat ini, satu-satunya nilai yang didukung adalah 'Semua' untuk menonaktifkan semua skenario ekspor data yang mungkin dengan kontrol yang lebih halus yang direncanakan untuk masa depan.
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.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 standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'.
properties.networkRuleSet	NetworkRuleSet		Aturan khusus jaringan yang menentukan bagaimana layanan Azure Cognitive Search dapat dicapai.
properties.partitionCount	integer	1	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 diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Daftar koneksi titik akhir privat ke layanan Azure Cognitive Search.
properties.provisioningState	ProvisioningState		Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status perantara yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'berhasil' atau 'gagal'. Aplikasi klien dapat melakukan polling status penyediaan (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 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.
properties.replicaCount	integer	1	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.
properties.semanticSearch	SearchSemanticSearch		Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU Azure Cognitive Search tertentu di lokasi tertentu.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Daftar sumber daya tautan privat bersama yang dikelola oleh layanan Azure Cognitive Search.
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 Azure Cognitive Search secara aktif menyelidiki masalah yang mendasar. Layanan khusus di status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.
properties.statusDetails	string		Detail status layanan pencarian.
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.
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 Azure Cognitive Search secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.

Name	Type	Description
degraded	string	Layanan pencarian terdegradasi karena unit pencarian yang mendasar tidak sehat.
deleting	string	Layanan pencarian sedang dihapus.
disabled	string	Layanan pencarian dinonaktifkan dan semua permintaan API akan ditolak.
error	string	Layanan pencarian dalam status kesalahan, menunjukkan kegagalan provisi atau dihapus.
provisioning	string	Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya.
running	string	Layanan pencarian sedang berjalan dan tidak ada operasi provisi yang sedang berlangsung.
stopped	string	Layanan pencarian berada dalam langganan yang dinonaktifkan.

SharedPrivateLinkResource

Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties	SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan Azure Cognitive Search.

Name	Type	Description
groupId	string	Id grup dari penyedia sumber daya untuk sumber daya tautan privat bersama adalah untuk.
privateLinkResourceId	string	Id sumber daya sumber daya untuk sumber daya tautan privat bersama adalah untuk.
provisioningState	SharedPrivateLinkResourceProvisioningState	Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau nilai lain yang belum di dokumentasikan.
requestMessage	string	Pesan permintaan untuk meminta persetujuan sumber daya tautan privat bersama.
resourceRegion	string	Opsional. Dapat digunakan untuk menentukan lokasi Azure Resource Manager sumber daya tempat tautan privat bersama akan dibuat. Ini hanya diperlukan untuk sumber daya yang konfigurasi DNS-nya regional (seperti Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, Terputus, atau nilai lain yang belum di dokumentasikan.

SharedPrivateLinkResourceProvisioningState

Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau nilai lain yang belum di dokumentasikan.

Name	Type	Description
Deleting	string	Sumber daya tautan privat bersama sedang dalam proses dihapus.
Failed	string	Sumber daya tautan privat bersama gagal disediakan atau dihapus.
Incomplete	string	Permintaan provisi untuk sumber daya tautan privat bersama telah diterima tetapi proses pembuatan belum dimulai.
Succeeded	string	Sumber daya tautan privat bersama telah selesai menyediakan dan siap untuk disetujui.
Updating	string	Sumber daya tautan privat bersama sedang dalam proses dibuat bersama dengan sumber daya lain agar berfungsi penuh.

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, Terputus, atau nilai lain yang belum di dokumentasikan.

Name	Type	Description
Approved	string	Sumber daya tautan privat bersama disetujui dan siap digunakan.
Disconnected	string	Sumber daya tautan privat bersama telah dihapus dari layanan.
Pending	string	Sumber daya tautan privat bersama telah dibuat dan menunggu persetujuan.
Rejected	string	Sumber daya tautan privat bersama telah ditolak dan tidak dapat digunakan.

Sku

Mendefinisikan SKU layanan Azure Cognitive Search, yang menentukan tingkat harga dan batas kapasitas.

Name	Type	Description
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 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.'

SkuName

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.'

Name	Type	Description
basic	string	Layanan khusus tingkat berbayar dengan hingga 3 replika.
free	string	Tingkat gratis, tanpa jaminan SLA dan subset fitur yang ditawarkan ke tingkat berbayar.
standard	string	Layanan khusus tingkat berbayar dengan hingga 12 partisi dan 12 replika.
standard2	string	Mirip dengan 'standar', tetapi dengan kapasitas lebih per unit pencarian.
standard3	string	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	string	Layanan khusus tingkat berbayar yang mendukung 1TB per partisi, hingga 12 partisi.
storage_optimized_l2	string	Layanan khusus tingkat berbayar yang mendukung 2TB per partisi, hingga 12 partisi.

UserAssignedManagedIdentity

Detail identitas terkelola yang ditetapkan pengguna yang ditetapkan ke layanan pencarian.

Name	Type	Description
clientId	string	ID klien identitas yang ditetapkan pengguna.
principalId	string	ID utama identitas yang ditetapkan pengguna.