Services - Get

Odwołanie

Usługa:: Search Management

Wersja interfejsu API:: 2023-11-01

Pobiera usługę wyszukiwania o podanej nazwie w danej grupie zasobów.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?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 Resource Manager platformy Azure lub portalu.
searchServiceName	path	True	string	Nazwa usługi wyszukiwania skojarzonej z określoną grupą zasobów.
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	SearchService	Definicja usługi wyszukiwania została pomyślnie pobrana i znajduje się w odpowiedzi. Jeśli sondujesz ukończenie operacji aprowizacji lub skalowania, możesz sprawdzić jej stan za pośrednictwem właściwości provisioningState.
Other Status Codes	CloudError	HTTP 404 (Nie znaleziono): nie można odnaleźć subskrypcji, grupy zasobów lub nazwy usługi wyszukiwania.

Zabezpieczenia

azure_auth

Tożsamość Microsoft Entra przepływ autoryzacji OAuth2.

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

SearchGetService

Przykładowe żądanie

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


/**
 * 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

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

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

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

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://zcusa.951200.xyz/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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
AadAuthFailureMode	Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania, która będzie wysyłać żądania, 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 na potrzeby uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra.
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	W tym artykule opisano zasady określające sposób szyfrowania zasobów w usłudze wyszukiwania za pomocą 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 umożliwiają 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". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".
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, które określają, jak można uzyskać dostęp 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 aprowizacjaStan 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 zobaczyć, kiedy operacja została 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 "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.
SearchEncryptionComplianceStatus	Opisuje, czy usługa wyszukiwania jest zgodna, czy nie ma zasobów niezaszyfrowanych przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a opcja "Wymuszanie" jest włączona, usługa zostanie oznaczona jako "nonCompliant".
SearchEncryptionWithCmk	W tym artykule opisano, jak usługa wyszukiwania powinna wymuszać stosowanie co najmniej jednego zasobu niezaszyfrowanego przez klienta.
SearchSemanticSearch	Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko w przypadku niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.
SearchService	Opisuje usługę wyszukiwania i jej bieżący stan.
SearchServiceStatus	Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, 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 obniżonej wydajności, wyłączenia lub błędu, 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 Private Link zarządzany przez usługę wyszukiwania.
SharedPrivateLinkResourceProperties	Opisuje właściwości istniejącego zasobu udostępnionego 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 zasobu udostępnionego łą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 szybkość 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 "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

Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania, która będzie wysyłać żądania, które zakończyły się niepowodzeniem uwierzytelniania.

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

ApiKeyOnly

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

CloudError

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

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

Wskazuje, że na potrzeby uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra.

Nazwa	Typ	Opis
aadAuthFailureMode	AadAuthFailureMode	Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania, która będzie wysyłać żądania, które zakończyły się niepowodzeniem uwierzytelniania.

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.

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

EncryptionWithCmk

W tym artykule opisano zasady określające sposób szyfrowania zasobów w usłudze wyszukiwania za pomocą kluczy zarządzanych przez klienta.

Nazwa	Typ	Opis
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Opisuje, czy usługa wyszukiwania jest zgodna, czy nie ma zasobów niezaszyfrowanych przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a opcja "Wymuszanie" jest włączona, usługa zostanie oznaczona jako "nonCompliant".
enforcement	SearchEncryptionWithCmk	W tym artykule opisano, jak usługa wyszukiwania powinna wymuszać stosowanie co najmniej jednego zasobu niezaszyfrowanego 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 umożliwiają 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". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".

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

Identity

Tożsamość zasobu.

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

IdentityType

Typ tożsamości.

Nazwa	Typ	Opis
None	string
SystemAssigned	string

IpRule

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

Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp 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 element "publicNetworkAccess" usługi wyszukiwania jest "włączony".

PrivateEndpoint

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

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

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

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

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

PrivateLinkServiceConnectionState

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

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

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

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 aprowizacjaStan 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 zobaczyć, kiedy operacja została 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.

Nazwa	Typ	Opis
failed	string	Ostatnia operacja aprowizacji nie powiodła się.
provisioning	string	Usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół.
succeeded	string	Ostatnia operacja aprowizacji zakończyła się pomyślnie.

PublicNetworkAccess

Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.

Nazwa	Typ	Opis
disabled	string
enabled	string

SearchEncryptionComplianceStatus

Opisuje, czy usługa wyszukiwania jest zgodna, czy nie ma zasobów niezaszyfrowanych przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a opcja "Wymuszanie" jest włączona, usługa zostanie oznaczona jako "nonCompliant".

Nazwa	Typ	Opis
Compliant	string	Wskazuje, że usługa wyszukiwania jest zgodna, ponieważ liczba zasobów niezaszyfrowanych przez klienta jest równa zero lub wymuszanie jest wyłączone.
NonCompliant	string	Wskazuje, że usługa wyszukiwania ma więcej niż jeden zasób niezaszyfrowany przez klienta.

SearchEncryptionWithCmk

W tym artykule opisano, jak usługa wyszukiwania powinna wymuszać stosowanie co najmniej jednego zasobu niezaszyfrowanego przez klienta.

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

SearchSemanticSearch

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

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

SearchService

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 wartość "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 umożliwiają 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". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".
properties.networkRuleSet	NetworkRuleSet		Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę wyszukiwania.
properties.partitionCount	integer	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 aprowizacjaStan 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 zobaczyć, kiedy operacja została 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 "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.
properties.replicaCount	integer	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 linków prywatnych zarządzanych przez usługę wyszukiwania.
properties.status	SearchServiceStatus		Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, 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 obniżonej wydajności, wyłączenia lub błędu, 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 szybkość rozliczeń 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"

SearchServiceStatus

Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, 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 obniżonej wydajności, wyłączenia lub błędu, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

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

SharedPrivateLinkResource

Opisuje udostępniony zasób 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 Private Link zarządzanego przez usługę wyszukiwania.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

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

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy od dostawcy zasobu, dla których jest udostępniany zasób łącza prywatnego.
privateLinkResourceId	string	Identyfikator zasobu zasobu, dla który jest udostępniany 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 żądania zatwierdzenia zasobu udostępnionego łącza prywatnego.
resourceRegion	string	Opcjonalny. Można użyć polecenia , aby określić lokalizację zasobu usługi Azure Resource Manager, do którego ma zostać utworzone udostępnione łącze prywatne. Jest to wymagane tylko dla tych zasobów, których konfiguracja DNS jest regionalna (na przykład Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stan zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

SharedPrivateLinkResourceProvisioningState

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

Nazwa	Typ	Opis
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

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

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

Sku

Definiuje jednostkę SKU usługi wyszukiwania, która określa szybkość 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": podobnie jak w warstwie 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 partycje o większej godzinie, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, do 12 partycji.

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

Nazwa	Typ	Opis
basic	string	Warstwa rozliczana dla dedykowanej usługi z maksymalnie 3 replikami.
free	string	Warstwa Bezpłatna, bez gwarancji SLA i podzbiór funkcji oferowanych w warstwach podlegających rozliczaniu.
standard	string	Warstwa rozliczana dla dedykowanej usługi z maksymalnie 12 partycjami i 12 replikami.
standard2	string	Podobnie jak w przypadku "standardu", ale z większą pojemnością na jednostkę wyszukiwania.
standard3	string	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	string	Warstwa rozliczana dla dedykowanej usługi, która obsługuje 1 TB na partycję, maksymalnie 12 partycji.
storage_optimized_l2	string	Warstwa rozliczana dla dedykowanej usługi, która obsługuje 2 TB na partycję, maksymalnie 12 partycji.