Services - Get

Layanan:

Search Management

Versi API:

2023-11-01

Mendapatkan layanan pencarian dengan nama yang diberikan dalam grup sumber daya yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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 pencarian yang terkait dengan grup sumber daya yang ditentukan.
subscriptionId	path	True	string	Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari Azure Resource Manager API, alat baris perintah, atau portal.
api-version	query	True	string	Versi API yang digunakan untuk setiap permintaan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	Nilai GUID yang dihasilkan klien yang mengidentifikasi permintaan ini. Jika ditentukan, ini akan disertakan dalam informasi respons sebagai cara untuk melacak permintaan.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchService	Definisi layanan pencarian berhasil diambil dan berada dalam respons. Jika Anda melakukan polling untuk penyelesaian provisi atau operasi skala, Anda dapat memeriksa statusnya melalui properti provisioningState.
Other Status Codes	CloudError	HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, atau nama layanan pencarian tidak dapat ditemukan.

Keamanan

azure_auth

Microsoft Entra ID alur otorisasi OAuth2.

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

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

SearchGetService

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

Java

/**
 * Samples for Services GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
     */
    /**
     * Sample code: SearchGetService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchGetService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().getByResourceGroupWithResponse("rg1",
            "mysearchservice", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_get_service.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsearch_test

import (
	"context"
	"log"

	"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/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
func ExampleServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().Get(ctx, "rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Service = armsearch.Service{
	// 	Name: to.Ptr("mysearchservice"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"app-name": to.Ptr("My e-commerce app"),
	// 	},
	// 	Properties: &armsearch.ServiceProperties{
	// 		HostingMode: to.Ptr(armsearch.HostingModeDefault),
	// 		NetworkRuleSet: &armsearch.NetworkRuleSet{
	// 			IPRules: []*armsearch.IPRule{
	// 			},
	// 		},
	// 		PartitionCount: to.Ptr[int32](1),
	// 		PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
	// 		ReplicaCount: to.Ptr[int32](3),
	// 		Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 		StatusDetails: to.Ptr(""),
	// 	},
	// 	SKU: &armsearch.SKU{
	// 		Name: to.Ptr(armsearch.SKUNameStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

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

/**
 * This sample demonstrates how to Gets the search service with the given name in the given resource group.
 *
 * @summary Gets the search service with the given name in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
 */
async function searchGetService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.get(resourceGroupName, searchServiceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
// this example is just showing the usage of "Services_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// invoke the operation
SearchServiceResource result = await searchService.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:

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": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

Definisi

Nama	Deskripsi
AadAuthFailureMode	Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi.
ApiKeyOnly	Menunjukkan bahwa hanya kunci API yang dapat 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 penyewa Microsoft Entra ID dapat digunakan untuk autentikasi.
DataPlaneAuthOptions	Menentukan opsi tentang cara layanan pencarian mengautentikasi permintaan sarana data. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.
EncryptionWithCmk	Menjelaskan kebijakan yang menentukan bagaimana sumber daya dalam layanan pencarian akan dienkripsi dengan kunci customer=managed.
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 dari layanan pencarian.
NetworkRuleSet	Aturan khusus jaringan yang menentukan bagaimana layanan pencarian dapat dicapai.
PrivateEndpoint	Sumber daya titik akhir privat dari penyedia Microsoft.Network.
PrivateEndpointConnection	Menjelaskan koneksi titik akhir privat yang ada ke layanan pencarian.
PrivateEndpointConnectionProperties	Menjelaskan properti koneksi Titik Akhir Privat yang ada ke layanan pencarian.
PrivateLinkServiceConnectionProvisioningState	Status penyediaan koneksi layanan tautan privat. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap
PrivateLinkServiceConnectionState	Menjelaskan status koneksi Layanan Private Link yang ada saat ini ke Titik Akhir Privat Azure.
PrivateLinkServiceConnectionStatus	Status koneksi layanan tautan privat. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.
ProvisioningState	Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status menengah yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'berhasil' atau 'gagal'. Aplikasi klien dapat melakukan polling status provisi (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan.
PublicNetworkAccess	Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang 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.
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 yang tidak dienkripsi 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 pencarian tertentu di lokasi tertentu.
SearchService	Menjelaskan layanan pencarian 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, Microsoft 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 pencarian.
SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan pencarian.
SharedPrivateLinkResourceProvisioningState	Status penyediaan sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.
SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.
Sku	Menentukan SKU layanan pencarian, yang menentukan tingkat penagihan dan batas kapasitas.
SkuName	SKU layanan pencarian. Nilai yang valid meliputi: 'gratis': Layanan bersama. '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.'

AadAuthFailureMode

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

Nama	Jenis	Deskripsi
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 dapat digunakan untuk autentikasi.

CloudError

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.
details	CloudErrorBody[]	Berisi kesalahan berlapis yang terkait dengan kesalahan ini.
message	string	Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.
target	string	Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

DataPlaneAadOrApiKeyAuthOption

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

Nama	Jenis	Deskripsi
aadAuthFailureMode	AadAuthFailureMode	Menjelaskan respons apa yang akan dikirim api sarana data dari layanan pencarian untuk permintaan yang gagal autentikasi.

DataPlaneAuthOptions

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

Nama	Jenis	Deskripsi
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Menunjukkan bahwa kunci API atau token akses dari penyewa Microsoft Entra ID dapat digunakan untuk autentikasi.
apiKeyOnly	ApiKeyOnly	Menunjukkan bahwa hanya kunci API yang dapat digunakan untuk autentikasi.

EncryptionWithCmk

Menjelaskan kebijakan yang menentukan bagaimana sumber daya dalam layanan pencarian akan dienkripsi dengan kunci customer=managed.

Nama	Jenis	Deskripsi
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 yang tidak dienkripsi 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'.

Nama	Jenis	Deskripsi
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

Identitas untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string	ID utama dari identitas layanan pencarian yang ditetapkan sistem.
tenantId	string	ID penyewa dari identitas layanan pencarian yang ditetapkan sistem.
type	IdentityType	Jenis identitas.

IdentityType

Jenis identitas.

Nama	Jenis	Deskripsi
None	string
SystemAssigned	string

IpRule

Aturan pembatasan IP dari layanan pencarian.

Nama	Jenis	Deskripsi
value	string	Nilai yang sesuai dengan satu alamat IPv4 (misalnya, 123.1.2.3) atau rentang IP dalam format CIDR (misalnya, 123.1.2.3/24) diizinkan.

NetworkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan pencarian dapat dicapai.

Nama	Jenis	Deskripsi
ipRules	IpRule[]	Daftar aturan pembatasan IP yang digunakan untuk firewall IP. IP apa pun yang tidak cocok dengan aturan diblokir oleh firewall. Aturan ini hanya diterapkan ketika 'publicNetworkAccess' dari layanan pencarian 'diaktifkan'.

PrivateEndpoint

Sumber daya titik akhir privat dari penyedia Microsoft.Network.

Nama	Jenis	Deskripsi
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 pencarian.

Nama	Jenis	Deskripsi
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 pencarian.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Menjelaskan properti koneksi Titik Akhir Privat yang ada ke layanan pencarian.

Nama	Jenis	Deskripsi
groupId	string	Id grup dari penyedia sumber daya untuk koneksi layanan tautan privat.
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.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Status penyediaan koneksi layanan tautan privat. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap

PrivateLinkServiceConnectionProvisioningState

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

Nama	Jenis	Deskripsi
Canceled	string	Permintaan provisi untuk sumber daya koneksi layanan tautan privat telah dibatalkan
Deleting	string	Koneksi layanan tautan privat sedang dalam proses dihapus.
Failed	string	Koneksi layanan tautan privat gagal disediakan atau dihapus.
Incomplete	string	Permintaan provisi untuk sumber daya koneksi layanan tautan privat telah diterima tetapi proses pembuatan belum dimulai.
Succeeded	string	Koneksi layanan tautan privat telah selesai menyediakan dan siap untuk disetujui.
Updating	string	Koneksi layanan tautan privat sedang dalam proses dibuat bersama dengan sumber daya lain agar berfungsi penuh.

PrivateLinkServiceConnectionState

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

Nama	Jenis	Nilai default	Deskripsi
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. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

PrivateLinkServiceConnectionStatus

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

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
disabled	string
enabled	string

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 yang tidak dienkripsi pelanggan dan 'Penegakan' 'diaktifkan' maka layanan akan ditandai sebagai 'nonCompliant'.

Nama	Jenis	Deskripsi
Compliant	string	Menunjukkan bahwa layanan pencarian sesuai, baik karena jumlah sumber daya yang tidak dienkripsi pelanggan adalah nol atau penerapan dinonaktifkan.
NonCompliant	string	Menunjukkan bahwa layanan pencarian memiliki lebih dari satu sumber daya yang tidak dienkripsi pelanggan.

SearchEncryptionWithCmk

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

Nama	Jenis	Deskripsi
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 pencarian tertentu di lokasi tertentu.

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

SearchService

Menjelaskan layanan pencarian dan statusnya saat ini.

Nama	Jenis	Nilai default	Deskripsi
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 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.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 pencarian 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 berlaku 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 pencarian.
properties.provisioningState	ProvisioningState		Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status menengah yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'berhasil' atau 'gagal'. Aplikasi klien dapat melakukan polling status provisi (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang 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 pencarian tertentu di lokasi tertentu.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Daftar sumber daya tautan privat bersama yang dikelola oleh layanan pencarian.
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, Microsoft secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.
properties.statusDetails	string		Detail status layanan pencarian.
sku	Sku		SKU layanan pencarian, yang menentukan tingkat penagihan 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, Microsoft secara aktif menyelidiki masalah yang mendasar. Layanan khusus dalam status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan.

Nama	Jenis	Deskripsi
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.

SharedPrivateLinkResource

Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan pencarian.

Nama	Jenis	Deskripsi
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 pencarian.
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 pencarian.

Nama	Jenis	Deskripsi
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. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.
requestMessage	string	Pesan permintaan untuk meminta persetujuan sumber daya tautan privat bersama.
resourceRegion	string	Pilihan. 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. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

SharedPrivateLinkResourceProvisioningState

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

Nama	Jenis	Deskripsi
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

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

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

Sku

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

Nama	Jenis	Deskripsi
name	SkuName	SKU layanan pencarian. Nilai yang valid meliputi: 'gratis': Layanan bersama. '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.'

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

Nama	Jenis	Deskripsi
basic	string	Tingkat yang dapat ditagih untuk layanan khusus yang memiliki hingga 3 replika.
free	string	Tingkat gratis, tanpa jaminan SLA dan subset fitur yang ditawarkan pada tingkat yang dapat ditagih.
standard	string	Tingkat yang dapat ditagih untuk layanan khusus yang memiliki 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	Tingkat yang dapat ditagih untuk layanan khusus yang mendukung 1TB per partisi, hingga 12 partisi.
storage_optimized_l2	string	Tingkat yang dapat ditagih untuk layanan khusus yang mendukung 2TB per partisi, hingga 12 partisi.