Services - Create Or Update

Service:

Search Management

API Version:

2020-08-01

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=2020-08-01

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

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

SearchCreateOrUpdateServiceWithIdentity

SearchCreateOrUpdateService

Sample Request

HTTP

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

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

Go

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/examples/SearchCreateOrUpdateService.json
func ExampleServicesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armsearch.NewServicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"mysearchservice",
		armsearch.Service{
			Location: to.Ptr("westus"),
			Tags: map[string]*string{
				"app-name": to.Ptr("My e-commerce app"),
			},
			Properties: &armsearch.ServiceProperties{
				HostingMode:    to.Ptr(armsearch.HostingModeDefault),
				PartitionCount: to.Ptr[int32](1),
				ReplicaCount:   to.Ptr[int32](3),
			},
			SKU: &armsearch.SKU{
				Name: to.Ptr(armsearch.SKUNameStandard),
			},
		},
		&armsearch.SearchManagementRequestOptions{ClientRequestID: nil},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavsScirpt

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 *
 * @summary Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/examples/SearchCreateOrUpdateService.json
 */
async function searchCreateOrUpdateService() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const searchServiceName = "mysearchservice";
  const service = {
    hostingMode: "default",
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    sku: { name: "standard" },
    tags: { appName: "My e-commerce app" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.beginCreateOrUpdateAndWait(
    resourceGroupName,
    searchServiceName,
    service
  );
  console.log(result);
}

searchCreateOrUpdateService().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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": []
    },
    "privateEndpointConnections": []
  }
}

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": []
    },
    "privateEndpointConnections": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Sample Request

HTTP

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

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

JavsScirpt

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 *
 * @summary Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json
 */
async function searchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const searchServiceName = "mysearchservice";
  const service = {
    hostingMode: "default",
    location: "westus",
    partitionCount: 1,
    publicNetworkAccess: "disabled",
    replicaCount: 3,
    sku: { name: "standard" },
    tags: { appName: "My e-commerce app" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.beginCreateOrUpdateAndWait(
    resourceGroupName,
    searchServiceName,
    service
  );
  console.log(result);
}

searchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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": []
    },
    "privateEndpointConnections": []
  }
}

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": []
    },
    "privateEndpointConnections": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Sample Request

HTTP

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

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

JavsScirpt

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 *
 * @summary Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json
 */
async function searchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const searchServiceName = "mysearchservice";
  const service = {
    hostingMode: "default",
    location: "westus",
    networkRuleSet: {
      ipRules: [{ value: "123.4.5.6" }, { value: "123.4.6.0/18" }],
    },
    partitionCount: 1,
    replicaCount: 1,
    sku: { name: "standard" },
    tags: { appName: "My e-commerce app" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.beginCreateOrUpdateAndWait(
    resourceGroupName,
    searchServiceName,
    service
  );
  console.log(result);
}

searchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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": []
  }
}

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": []
  }
}

SearchCreateOrUpdateServiceWithIdentity

Sample Request

HTTP

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

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

JavsScirpt

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 *
 * @summary Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/examples/SearchCreateOrUpdateServiceWithIdentity.json
 */
async function searchCreateOrUpdateServiceWithIdentity() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const searchServiceName = "mysearchservice";
  const service = {
    hostingMode: "default",
    identity: { type: "SystemAssigned" },
    location: "westus",
    partitionCount: 1,
    replicaCount: 3,
    sku: { name: "standard" },
    tags: { appName: "My e-commerce app" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.beginCreateOrUpdateAndWait(
    resourceGroupName,
    searchServiceName,
    service
  );
  console.log(result);
}

searchCreateOrUpdateServiceWithIdentity().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
  }
}

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": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
  }
}

Definisi

CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
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	Identitas untuk sumber daya.
IdentityType	Jenis identitas.
IpRule	Aturan pembatasan IP 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.
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. 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, atau Tidak Lengkap.
SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.
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. '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.'

CloudError

Berisi informasi tentang kesalahan API.

Name	Type	Description
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

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

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
highDensity	string

Identity

Identitas untuk sumber daya.

Name	Type	Description
principalId	string	ID utama identitas sumber daya.
tenantId	string	ID penyewa sumber daya.
type	IdentityType	Jenis identitas.

IdentityType

Jenis identitas.

Name	Type	Description
None	string
SystemAssigned	string

IpRule

Aturan pembatasan IP 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) diizinkan.

NetworkRuleSet

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

Name	Type	Description
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
Disconnected	string
Pending	string
Rejected	string

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
provisioning	string
succeeded	string

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
enabled	string

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.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.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. 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. 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
deleting	string
disabled	string
error	string
provisioning	string
running	string

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.
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, atau Tidak Lengkap.
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, atau Terputus.

SharedPrivateLinkResourceProvisioningState

Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.

Name	Type	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

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

Name	Type	Description
basic	string
free	string
standard	string
standard2	string
standard3	string
storage_optimized_l1	string
storage_optimized_l2	string