Services - List By Resource Group

Usługa:

Search Management

Wersja interfejsu API:

2023-11-01

Pobiera listę wszystkich usług wyszukiwania w danej grupie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
subscriptionId	path	True	string	Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager, narzędzi wiersza polecenia lub portalu.
api-version	query	True	string	Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach o odpowiedzi jako sposób śledzenia żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchServiceListResult	Operacja zakończyła się pomyślnie. Odpowiedź zawiera listę wszystkich definicji usługi wyszukiwania dla danej grupy zasobów.
Other Status Codes	CloudError	Wystąpił nieoczekiwany błąd podczas operacji.

Zabezpieczenia

azure_auth

Przepływ autoryzacji OAuth2 identyfikatora Entra firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

SearchListServicesByResourceGroup

Przykładowe żądanie

HTTP

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

Java

/**
 * Samples for Services ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * SearchListServicesByResourceGroup.json
     */
    /**
     * Sample code: SearchListServicesByResourceGroup.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchListServicesByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().listByResourceGroup("rg1", 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_list_services_by_resource_group.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.list_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.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/SearchListServicesByResourceGroup.json
func ExampleServicesClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewServicesClient().NewListByResourceGroupPager("rg1", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServiceListResult = armsearch.ServiceListResult{
		// 	Value: []*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),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mysearchservice2"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice2"),
		// 			Location: to.Ptr("eastus"),
		// 			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](1),
		// 				Status: to.Ptr(armsearch.SearchServiceStatusRunning),
		// 				StatusDetails: to.Ptr(""),
		// 			},
		// 			SKU: &armsearch.SKU{
		// 				Name: to.Ptr(armsearch.SKUNameBasic),
		// 			},
		// 	}},
		// }
	}
}

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 a list of all Search services in the given resource group.
 *
 * @summary Gets a list of all Search services in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.json
 */
async function searchListServicesByResourceGroup() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.services.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/SearchListServicesByResourceGroup.json
// this example is just showing the usage of "Services_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SearchServiceResource
SearchServiceCollection collection = resourceGroupResource.GetSearchServices();

// invoke the operation and iterate over the result
await foreach (SearchServiceResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "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": []
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice2",
      "name": "mysearchservice2",
      "location": "eastus",
      "type": "Microsoft.Search/searchServices",
      "tags": {
        "app-name": "My e-commerce app"
      },
      "sku": {
        "name": "basic"
      },
      "properties": {
        "replicaCount": 1,
        "partitionCount": 1,
        "status": "running",
        "statusDetails": "",
        "hostingMode": "default",
        "provisioningState": "succeeded",
        "publicNetworkAccess": "enabled",
        "networkRuleSet": {
          "ipRules": []
        },
        "privateEndpointConnections": []
      }
    }
  ]
}

Definicje

Nazwa	Opis
AadAuthFailureMode	Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.
ApiKeyOnly	Wskazuje, że tylko klucz interfejsu API może być używany do uwierzytelniania.
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
DataPlaneAadOrApiKeyAuthOption	Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy identyfikatora Entra firmy Microsoft.
DataPlaneAuthOptions	Definiuje opcje uwierzytelniania żądania płaszczyzny danych przez usługę wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.
EncryptionWithCmk	Opisuje zasady określające, w jaki sposób zasoby w usłudze wyszukiwania mają być szyfrowane przy użyciu kluczy zarządzanych przez klienta.
HostingMode	Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi być wartością domyślną.
Identity	Tożsamość zasobu.
IdentityType	Typ tożsamości.
IpRule	Reguła ograniczeń adresów IP usługi wyszukiwania.
NetworkRuleSet	Reguły specyficzne dla sieci określające sposób uzyskiwania dostępu do usługi wyszukiwania.
PrivateEndpoint	Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.
PrivateEndpointConnection	Opisuje istniejące połączenie prywatnego punktu końcowego z usługą wyszukiwania.
PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.
PrivateLinkServiceConnectionProvisioningState	Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne
PrivateLinkServiceConnectionState	Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.
PrivateLinkServiceConnectionStatus	Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.
ProvisioningState	Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności provisioningState zmieni się na "powodzenie" lub "niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby sprawdzić, kiedy operacja zostanie ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.
PublicNetworkAccess	Tę wartość można ustawić na wartość "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. W przypadku ustawienia wartości "disabled" ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a połączenia prywatnych punktów końcowych będą wyłączną metodą dostępu.
SearchEncryptionComplianceStatus	Opisuje, czy usługa wyszukiwania jest zgodna z zasobami niezaszyfrowanymi przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a "Wymuszanie" jest "włączone", usługa zostanie oznaczona jako "nonCompliant".
SearchEncryptionWithCmk	Opisuje sposób wymuszania przez usługę wyszukiwania posiadania co najmniej jednego zasobu niezaszyfrowanego przez klienta.
SearchSemanticSearch	Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.
SearchService	Opisuje usługę wyszukiwania i jej bieżący stan.
SearchServiceListResult	Odpowiedź zawierająca listę usług wyszukiwania.
SearchServiceStatus	Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": obniżona wydajność usługi wyszukiwania. Taka sytuacja może wystąpić, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach o obniżonej wydajności, wyłączonej lub błędzie, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.
SharedPrivateLinkResource	Opisuje udostępniony zasób usługi Private Link zarządzany przez usługę wyszukiwania.
SharedPrivateLinkResourceProperties	Opisuje właściwości istniejącego udostępnionego zasobu usługi Private Link zarządzanego przez usługę wyszukiwania.
SharedPrivateLinkResourceProvisioningState	Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.
SharedPrivateLinkResourceStatus	Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.
Sku	Definiuje jednostkę SKU usługi wyszukiwania, która określa stawkę rozliczeń i limity pojemności.
SkuName	Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobny do standardowego, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, maksymalnie 12 partycji.

AadAuthFailureMode

Wyliczanie

Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.

Wartość	Opis
http401WithBearerChallenge	Wskazuje, że żądania, które zakończyły się niepowodzeniem uwierzytelniania, powinny zostać wyświetlone z kodem stanu HTTP 401 (Brak autoryzacji) i przedstawić zadanie elementu nośnego.
http403	Wskazuje, że żądania, które zakończyły się niepowodzeniem uwierzytelniania, powinny być wyświetlane z kodem stanu HTTP 403 (Zabronione).

ApiKeyOnly

Objekt

Wskazuje, że tylko klucz interfejsu API może być używany do uwierzytelniania.

CloudError

Objekt

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

CloudErrorBody

Objekt

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

DataPlaneAadOrApiKeyAuthOption

Objekt

Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy identyfikatora Entra firmy Microsoft.

Nazwa	Typ	Opis
aadAuthFailureMode	AadAuthFailureMode	Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.

DataPlaneAuthOptions

Objekt

Definiuje opcje uwierzytelniania żądania płaszczyzny danych przez usługę wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.

Nazwa	Typ	Opis
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy identyfikatora Entra firmy Microsoft.
apiKeyOnly	ApiKeyOnly	Wskazuje, że tylko klucz interfejsu API może być używany do uwierzytelniania.

EncryptionWithCmk

Objekt

Opisuje zasady określające, w jaki sposób zasoby w usłudze wyszukiwania mają być szyfrowane przy użyciu kluczy zarządzanych przez klienta.

Nazwa	Typ	Opis
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Opisuje, czy usługa wyszukiwania jest zgodna z zasobami niezaszyfrowanymi przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a "Wymuszanie" jest "włączone", usługa zostanie oznaczona jako "nonCompliant".
enforcement	SearchEncryptionWithCmk	Opisuje sposób wymuszania przez usługę wyszukiwania posiadania co najmniej jednego zasobu niezaszyfrowanego przez klienta.

HostingMode

Wyliczanie

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi być wartością domyślną.

Wartość	Opis
default	Limit liczby indeksów jest określany przez domyślne limity dla jednostki SKU.
highDensity	Tylko aplikacja dla jednostki SKU w warstwie Standardowa3, w której usługa wyszukiwania może mieć maksymalnie 1000 indeksów.

Identity

Objekt

Tożsamość zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez system usługi wyszukiwania.
tenantId	string	Identyfikator dzierżawy przypisanej przez system tożsamości usługi wyszukiwania.
type	IdentityType	Typ tożsamości.

IdentityType

Wyliczanie

Typ tożsamości.

Wartość	Opis
None
SystemAssigned

IpRule

Objekt

Reguła ograniczeń adresów IP usługi wyszukiwania.

Nazwa	Typ	Opis
value	string	Wartość odpowiadająca pojedynczemu adresowi IPv4 (na przykład 123.1.2.3) lub zakresowi adresów IP w formacie CIDR (na przykład 123.1.2.3/24) może być dozwolona.

NetworkRuleSet

Objekt

Reguły specyficzne dla sieci określające sposób uzyskiwania dostępu do usługi wyszukiwania.

Nazwa	Typ	Opis
ipRules	IpRule[]	Lista reguł ograniczeń adresów IP używanych dla zapory adresów IP. Wszystkie adresy IP niezgodne z regułami są blokowane przez zaporę. Te reguły są stosowane tylko wtedy, gdy "publicNetworkAccess" usługi wyszukiwania jest "włączone".

PrivateEndpoint

Objekt

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego od dostawcy Microsoft.Network.

PrivateEndpointConnection

Objekt

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą wyszukiwania.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy od dostawcy zasobu jest przeznaczony dla połączenia usługi private link.
privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne

PrivateLinkServiceConnectionProvisioningState

Wyliczanie

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne

Wartość	Opis
Canceled	Żądanie aprowizacji zasobu połączenia usługi private link zostało anulowane
Deleting	Połączenie usługi łącza prywatnego jest w trakcie usuwania.
Failed	Nie można zainicjować obsługi administracyjnej lub usunąć połączenia usługi łącza prywatnego.
Incomplete	Żądanie aprowizacji zasobu połączenia usługi private link zostało zaakceptowane, ale proces tworzenia nie został jeszcze rozpoczęty.
Succeeded	Połączenie usługi private link zakończyło aprowizację i jest gotowe do zatwierdzenia.
Updating	Połączenie usługi łącza prywatnego jest w trakcie tworzenia wraz z innymi zasobami, które mają być w pełni funkcjonalne.

PrivateLinkServiceConnectionState

Objekt

Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.

Nazwa	Typ	Domyślna wartość	Opis
actionsRequired	string	None	Opis wszelkich dodatkowych akcji, które mogą być wymagane.
description	string		Opis stanu połączenia usługi łącza prywatnego.
status	PrivateLinkServiceConnectionStatus		Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

PrivateLinkServiceConnectionStatus

Wyliczanie

Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Wartość	Opis
Approved	Połączenie prywatnego punktu końcowego jest zatwierdzone i jest gotowe do użycia.
Disconnected	Połączenie prywatnego punktu końcowego zostało usunięte z usługi.
Pending	Połączenie prywatnego punktu końcowego zostało utworzone i oczekuje na zatwierdzenie.
Rejected	Połączenie prywatnego punktu końcowego zostało odrzucone i nie można go użyć.

ProvisioningState

Wyliczanie

Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności provisioningState zmieni się na "powodzenie" lub "niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby sprawdzić, kiedy operacja zostanie ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.

Wartość	Opis
failed	Ostatnia operacja aprowizacji nie powiodła się.
provisioning	Usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół.
succeeded	Ostatnia operacja aprowizacji została ukończona pomyślnie.

PublicNetworkAccess

Wyliczanie

Tę wartość można ustawić na wartość "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. W przypadku ustawienia wartości "disabled" ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a połączenia prywatnych punktów końcowych będą wyłączną metodą dostępu.

Wartość	Opis
disabled
enabled

SearchEncryptionComplianceStatus

Wyliczanie

Opisuje, czy usługa wyszukiwania jest zgodna z zasobami niezaszyfrowanymi przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a "Wymuszanie" jest "włączone", usługa zostanie oznaczona jako "nonCompliant".

Wartość	Opis
Compliant	Wskazuje, że usługa wyszukiwania jest zgodna, ponieważ liczba zasobów niezaszyfrowanych przez klienta jest zerowa lub wymuszanie jest wyłączone.
NonCompliant	Wskazuje, że usługa wyszukiwania ma więcej niż jeden zasób niezaszyfrowany przez klienta.

SearchEncryptionWithCmk

Wyliczanie

Opisuje sposób wymuszania przez usługę wyszukiwania posiadania co najmniej jednego zasobu niezaszyfrowanego przez klienta.

Wartość	Opis
Disabled	Nie zostanie wykonane wymuszanie, a usługa wyszukiwania może mieć zasoby niezaszyfrowane przez klienta.
Enabled	Usługa wyszukiwania zostanie oznaczona jako niezgodna, jeśli istnieje co najmniej jeden zasób niezaszyfrowany przez klienta.
Unspecified	Zasady wymuszania nie są jawnie określone, a zachowanie jest takie samo, jak w przypadku ustawienia opcji "Wyłączone".

SearchSemanticSearch

Wyliczanie

Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.

Wartość	Opis
disabled	Wskazuje, że klasyfikacja semantyczna jest wyłączona dla usługi wyszukiwania.
free	Włącza semantyczną klasyfikację w usłudze wyszukiwania i wskazuje, że ma być używana w granicach warstwy Bezpłatna. Spowoduje to ograniczenie liczby semantycznych żądań klasyfikacji i jest oferowane bez dodatkowych opłat. Jest to ustawienie domyślne dla nowo aprowizowania usług wyszukiwania.
standard	Umożliwia semantyczne klasyfikowanie w usłudze wyszukiwania jako funkcji rozliczanej z wyższą przepływnością i ilością żądań klasyfikacji semantycznej.

SearchService

Objekt

Opisuje usługę wyszukiwania i jej bieżący stan.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Tożsamość zasobu.
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.authOptions	DataPlaneAuthOptions		Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.
properties.disableLocalAuth	boolean		Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".
properties.encryptionWithCmk	EncryptionWithCmk		Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.
properties.hostingMode	HostingMode	default	Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi być wartością domyślną.
properties.networkRuleSet	NetworkRuleSet		Reguły specyficzne dla sieci określające sposób uzyskiwania dostępu do usługi wyszukiwania.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista połączeń prywatnego punktu końcowego z usługą wyszukiwania.
properties.provisioningState	ProvisioningState		Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności provisioningState zmieni się na "powodzenie" lub "niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby sprawdzić, kiedy operacja zostanie ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Tę wartość można ustawić na wartość "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. W przypadku ustawienia wartości "disabled" ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a połączenia prywatnych punktów końcowych będą wyłączną metodą dostępu.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.
properties.semanticSearch	SearchSemanticSearch		Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Lista udostępnionych zasobów łącza prywatnego zarządzanych przez usługę wyszukiwania.
properties.status	SearchServiceStatus		Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": obniżona wydajność usługi wyszukiwania. Taka sytuacja może wystąpić, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach o obniżonej wydajności, wyłączonej lub błędzie, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.
properties.statusDetails	string		Szczegóły stanu usługi wyszukiwania.
sku	Sku		Jednostka SKU usługi wyszukiwania, która określa stawkę rozliczeniową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SearchServiceListResult

Objekt

Odpowiedź zawierająca listę usług wyszukiwania.

Nazwa	Typ	Opis
nextLink	string	Adres URL żądania, który może służyć do wykonywania zapytań względem następnej strony usług wyszukiwania. Zwracane, gdy łączna liczba żądanych usług wyszukiwania przekracza maksymalny rozmiar strony.
value	SearchService[]	Lista usług wyszukiwania.

SearchServiceStatus

Wyliczanie

Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": obniżona wydajność usługi wyszukiwania. Taka sytuacja może wystąpić, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach o obniżonej wydajności, wyłączonej lub błędzie, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

Wartość	Opis
degraded	Usługa wyszukiwania jest obniżona, ponieważ bazowe jednostki wyszukiwania nie są w dobrej kondycji.
deleting	Usługa wyszukiwania jest usuwana.
disabled	Usługa wyszukiwania jest wyłączona i wszystkie żądania interfejsu API zostaną odrzucone.
error	Usługa wyszukiwania jest w stanie błędu wskazująca błąd aprowizacji lub usunięcia.
provisioning	Usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół.
running	Usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji.

SharedPrivateLinkResource

Objekt

Opisuje udostępniony zasób usługi Private Link zarządzany przez usługę wyszukiwania.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	SharedPrivateLinkResourceProperties	Opisuje właściwości udostępnionego zasobu usługi Private Link zarządzanego przez usługę wyszukiwania.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Objekt

Opisuje właściwości istniejącego udostępnionego zasobu usługi Private Link zarządzanego przez usługę wyszukiwania.

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy od dostawcy zasobu jest przeznaczony dla zasobu udostępnionego łącza prywatnego.
privateLinkResourceId	string	Identyfikator zasobu zasobu, dla których znajduje się udostępniony zasób łącza prywatnego.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.
requestMessage	string	Komunikat żądania żądania zatwierdzenia udostępnionego zasobu łącza prywatnego.
resourceRegion	string	Opcjonalny. Można użyć do określenia lokalizacji usługi Azure Resource Manager zasobu, do którego ma zostać utworzony udostępniony link prywatny. Jest to wymagane tylko dla tych zasobów, których konfiguracja DNS jest regionalna (na przykład Usługa Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

SharedPrivateLinkResourceProvisioningState

Wyliczanie

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.

Wartość	Opis
Deleting
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

Wyliczanie

Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Wartość	Opis
Approved
Disconnected
Pending
Rejected

Sku

Objekt

Definiuje jednostkę SKU usługi wyszukiwania, która określa stawkę rozliczeń i limity pojemności.

Nazwa	Typ	Opis
name	SkuName	Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobny do standardowego, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, maksymalnie 12 partycji.

SkuName

Wyliczanie

Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobny do standardowego, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, maksymalnie 12 partycji.

Wartość	Opis
basic	Rozliczana warstwa dla dedykowanej usługi z maksymalnie 3 replikami.
free	Warstwa Bezpłatna bez gwarancji SLA i podzbiór funkcji oferowanych w warstwach rozliczanych.
standard	Warstwa rozliczana dla dedykowanej usługi z maksymalnie 12 partycjami i 12 replikami.
standard2	Podobnie jak w przypadku warstwy "Standardowa", ale z większą pojemnością na jednostkę wyszukiwania.
standard3	Największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycjami z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity").
storage_optimized_l1	Warstwa rozliczana dla dedykowanej usługi, która obsługuje 1 TB na partycję, do 12 partycji.
storage_optimized_l2	Warstwa rozliczana dla dedykowanej usługi, która obsługuje 2 TB na partycję, do 12 partycji.