Services - Get

Služba:

Search Management

Verze rozhraní API:

2023-11-01

Získá vyhledávací službu s daným názvem v dané skupině prostředků.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName	path	True	string	Název vyhledávací služby přidružené k zadané skupině prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Odpovědi

Name	Typ	Description
200 OK	SearchService	Definice vyhledávací služby byla úspěšně načtena a je v odpovědi. Pokud dotazujete dokončení operace zřizování nebo škálování, můžete zkontrolovat její stav prostřednictvím vlastnosti provisioningState.
Other Status Codes	CloudError	HTTP 404 (Nenalezena): Nepodařilo se najít název předplatného, skupiny prostředků nebo vyhledávací služby.

Zabezpečení

azure_auth

Tok autorizace Microsoft Entra ID OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SearchGetService

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AadAuthFailureMode	Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování.
ApiKeyOnly	Označuje, že k ověřování je možné použít pouze klíč rozhraní API.
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
DataPlaneAadOrApiKeyAuthOption	Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID.
DataPlaneAuthOptions	Definuje možnosti, jak vyhledávací služba ověřuje požadavek roviny dat. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.
EncryptionWithCmk	Popisuje zásadu, která určuje, jak se mají prostředky ve vyhledávací službě šifrovat pomocí klíčů spravovaných zákazníkem.
HostingMode	Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.
Identity	Identita prostředku
IdentityType	Typ identity.
IpRule	Pravidlo omezení PROTOKOLU IP vyhledávací služby.
NetworkRuleSet	Pravidla specifická pro síť, která určují, jak lze dosáhnout vyhledávací služby.
PrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
PrivateEndpointConnection	Popisuje existující připojení privátního koncového bodu k vyhledávací službě.
PrivateEndpointConnectionProperties	Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.
PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěch nebo Neúplné.
PrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Private Link k privátnímu koncovému bodu Azure.
PrivateLinkServiceConnectionStatus	Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.
ProvisioningState	Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na "úspěch" nebo "selhalo". Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěšná přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.
PublicNetworkAccess	Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.
SearchEncryptionComplianceStatus	Popisuje, jestli vyhledávací služba dodržuje předpisy nebo ne, pokud jde o nešifrované prostředky bez zákazníka. Pokud má služba více než jeden prostředek, který není zašifrovaný zákazníkem, a je povoleno vynucení, služba se označí jako nedodržující předpisy.
SearchEncryptionWithCmk	Popisuje, jak má vyhledávací služba vynutit, aby jeden nebo více prostředků nezašifrovaných zákazníkem.
SearchSemanticSearch	Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná pouze pro určité skladové položky vyhledávání v určitých umístěních.
SearchService	Popisuje vyhledávací službu a její aktuální stav.
SearchServiceStatus	Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, Microsoft aktivně zkoumá základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.
SharedPrivateLinkResource	Popisuje prostředek sdíleného privátního propojení spravovaný vyhledávací službou.
SharedPrivateLinkResourceProperties	Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného vyhledávací službou.
SharedPrivateLinkResourceProvisioningState	Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.
SharedPrivateLinkResourceStatus	Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.
Sku	Definuje skladovou položku vyhledávací služby, která určuje fakturační sazbu a limity kapacity.
SkuName	Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů.

AadAuthFailureMode

Výčet

Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování.

Hodnota	Description
http401WithBearerChallenge	Označuje, že požadavky, které selhaly ověřování, by měly být prezentovány se stavovým kódem HTTP 401 (Neautorizováno) a prezentovat nosnou výzvu.
http403	Označuje, že požadavky, které selhaly ověřování, by se měly zobrazit se stavovým kódem HTTP 403 (Zakázáno).

ApiKeyOnly

Objekt

Označuje, že k ověřování je možné použít pouze klíč rozhraní API.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

DataPlaneAadOrApiKeyAuthOption

Objekt

Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID.

Name	Typ	Description
aadAuthFailureMode	AadAuthFailureMode	Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování.

DataPlaneAuthOptions

Objekt

Definuje možnosti, jak vyhledávací služba ověřuje požadavek roviny dat. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

Name	Typ	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID.
apiKeyOnly	ApiKeyOnly	Označuje, že k ověřování je možné použít pouze klíč rozhraní API.

EncryptionWithCmk

Objekt

Popisuje zásadu, která určuje, jak se mají prostředky ve vyhledávací službě šifrovat pomocí klíčů spravovaných zákazníkem.

Name	Typ	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Popisuje, jestli vyhledávací služba dodržuje předpisy nebo ne, pokud jde o nešifrované prostředky bez zákazníka. Pokud má služba více než jeden prostředek, který není zašifrovaný zákazníkem, a je povoleno vynucení, služba se označí jako nedodržující předpisy.
enforcement	SearchEncryptionWithCmk	Popisuje, jak má vyhledávací služba vynutit, aby jeden nebo více prostředků nezašifrovaných zákazníkem.

HostingMode

Výčet

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

Hodnota	Description
default	Omezení počtu indexů je určeno výchozími limity skladové položky.
highDensity	Pouze aplikace pro skladovou položku Standard3, kde vyhledávací služba může mít až 1 000 indexů.

Identity

Objekt

Identita prostředku

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity přiřazené systémem vyhledávací služby.
tenantId	string	ID tenanta identity přiřazené systémem vyhledávací služby.
type	IdentityType	Typ identity.

IdentityType

Výčet

Typ identity.

Hodnota	Description
None
SystemAssigned

IpRule

Objekt

Pravidlo omezení PROTOKOLU IP vyhledávací služby.

Name	Typ	Description
value	string	Hodnota odpovídající jedné adrese IPv4 (například 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (například 123.1.2.3/24).

NetworkRuleSet

Objekt

Pravidla specifická pro síť, která určují, jak lze dosáhnout vyhledávací služby.

Name	Typ	Description
ipRules	IpRule[]	Seznam pravidel omezení PROTOKOLU IP používaných pro bránu firewall protokolu IP Všechny IP adresy, které neodpovídají pravidlu, jsou blokovány bránou firewall. Tato pravidla se použijí jenom v případech, kdy je povolená "publicNetworkAccess" vyhledávací služby.

PrivateEndpoint

Objekt

Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.

Name	Typ	Description
id	string	ID prostředku privátního koncového bodu od poskytovatele Microsoft.Network.

PrivateEndpointConnection

Objekt

Popisuje existující připojení privátního koncového bodu k vyhledávací službě.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	PrivateEndpointConnectionProperties	Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionProperties

Objekt

Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.

Name	Typ	Description
groupId	string	ID skupiny od poskytovatele prostředku, pro které je připojení služby Private Link určené.
privateEndpoint	PrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Private Link k privátnímu koncovému bodu Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěch nebo Neúplné.

PrivateLinkServiceConnectionProvisioningState

Výčet

Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěch nebo Neúplné.

Hodnota	Description
Canceled	Žádost o zřízení prostředku připojení služby Private Link byla zrušena.
Deleting	Připojení služby Private Link probíhá v procesu odstranění.
Failed	Připojení služby Private Link se nepodařilo zřídit nebo odstranit.
Incomplete	Žádost o zřízení prostředku připojení služby Private Link byla přijata, ale proces vytvoření ještě nebyl zahájen.
Succeeded	Připojení služby Private Link dokončilo zřizování a je připravené ke schválení.
Updating	Připojení služby Private Link probíhá v procesu vytváření spolu s dalšími prostředky, aby bylo plně funkční.

PrivateLinkServiceConnectionState

Objekt

Popisuje aktuální stav existujícího připojení služby Private Link k privátnímu koncovému bodu Azure.

Name	Typ	Default value	Description
actionsRequired	string	None	Popis všech dodatečných akcí, které mohou být vyžadovány.
description	string		Popis stavu připojení služby Private Link.
status	PrivateLinkServiceConnectionStatus		Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

PrivateLinkServiceConnectionStatus

Výčet

Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota	Description
Approved	Připojení privátního koncového bodu je schválené a je připravené k použití.
Disconnected	Připojení privátního koncového bodu bylo ze služby odebráno.
Pending	Připojení privátního koncového bodu se vytvořilo a čeká na schválení.
Rejected	Připojení privátního koncového bodu bylo odmítnuto a nelze ho použít.

ProvisioningState

Výčet

Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na "úspěch" nebo "selhalo". Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěšná přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.

Hodnota	Description
failed	Poslední operace zřizování selhala.
provisioning	Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů.
succeeded	Poslední operace zřizování byla úspěšně dokončena.

PublicNetworkAccess

Výčet

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

Hodnota	Description
disabled
enabled

SearchEncryptionComplianceStatus

Výčet

Popisuje, jestli vyhledávací služba dodržuje předpisy nebo ne, pokud jde o nešifrované prostředky bez zákazníka. Pokud má služba více než jeden prostředek, který není zašifrovaný zákazníkem, a je povoleno vynucení, služba se označí jako nedodržující předpisy.

Hodnota	Description
Compliant	Označuje, že vyhledávací služba dodržuje předpisy, a to buď kvůli počtu nešifrovaných prostředků, které nejsou zákazníky, je nula nebo je zakázáno vynucování.
NonCompliant	Označuje, že vyhledávací služba má více než jeden nešifrovaný prostředky bez zákazníka.

SearchEncryptionWithCmk

Výčet

Popisuje, jak má vyhledávací služba vynutit, aby jeden nebo více prostředků nezašifrovaných zákazníkem.

Hodnota	Description
Disabled	Neprovedou se žádné vynucení a vyhledávací služba může mít prostředky bez šifrování zákazníka.
Enabled	Vyhledávací služba se označí jako nevyhovující, pokud existuje jeden nebo více prostředků, které nejsou šifrované zákazníkem.
Unspecified	Zásady vynucení nejsou explicitně zadány, přičemž chování je stejné jako v případě, že byly nastaveny na Zakázáno.

SearchSemanticSearch

Výčet

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná pouze pro určité skladové položky vyhledávání v určitých umístěních.

Hodnota	Description
disabled	Označuje, že sémantické řazení je pro vyhledávací službu zakázané.
free	Umožňuje sémantické řazení vyhledávací služby a indikuje, že se má používat v rámci limitů úrovně Free. To by limitoval objem sémantických žádostí o řazení a nabízí se bez dalších poplatků. Toto je výchozí hodnota pro nově zřízené vyhledávací služby.
standard	Umožňuje sémantické řazení vyhledávací služby jako fakturovatelnou funkci s vyšší propustností a objemem sémantických žádostí o řazení.

SearchService

Objekt

Popisuje vyhledávací službu a její aktuální stav.

Name	Typ	Default value	Description
id	string		Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Identita prostředku.
location	string		Geografické umístění, ve kterém se nachází zdroj
name	string		Název prostředku
properties.authOptions	DataPlaneAuthOptions		Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.
properties.disableLocalAuth	boolean		Pokud je nastavená hodnota true, nebudou volání vyhledávací služby povolena k ověřování pomocí klíčů rozhraní API. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definovány hodnoty dataPlaneAuthOptions.
properties.encryptionWithCmk	EncryptionWithCmk		Určuje všechny zásady týkající se šifrování prostředků (například indexů) pomocí klíčů správce zákazníků v rámci vyhledávací služby.
properties.hostingMode	HostingMode	default	Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.
properties.networkRuleSet	NetworkRuleSet		Pravidla specifická pro síť, která určují, jak je možné dosáhnout vyhledávací služby.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Počet oddílů ve vyhledávací službě; pokud je zadaný, může to být 1, 2, 3, 4, 6 nebo 12. Hodnoty větší než 1 jsou platné pouze pro standardní skladové položky. Pro služby standard3 s hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Seznam připojení privátních koncových bodů k vyhledávací službě.
properties.provisioningState	ProvisioningState		Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na "úspěch" nebo "selhalo". Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěšná přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	Počet replik ve vyhledávací službě. Pokud je zadáno, musí být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro základní skladovou položku.
properties.semanticSearch	SearchSemanticSearch		Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná pouze pro určité skladové položky vyhledávání v určitých umístěních.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Seznam sdílených prostředků privátního propojení spravovaných vyhledávací službou.
properties.status	SearchServiceStatus		Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, Microsoft aktivně zkoumá základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.
properties.statusDetails	string		Podrobnosti o stavu vyhledávací služby.
sku	Sku		Skladová položka vyhledávací služby, která určuje fakturační sazbu a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.
tags	object		Značky prostředků
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SearchServiceStatus

Výčet

Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, Microsoft aktivně zkoumá základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.

Hodnota	Description
degraded	Vyhledávací služba je degradovaná, protože základní jednotky vyhledávání nejsou v pořádku.
deleting	Vyhledávací služba se odstraňuje.
disabled	Vyhledávací služba je zakázaná a všechny požadavky rozhraní API budou odmítnuty.
error	Vyhledávací služba je ve stavu chyby, která značí, že se nepodařilo zřídit nebo odstranit.
provisioning	Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů.
running	Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování.

SharedPrivateLinkResource

Objekt

Popisuje prostředek sdíleného privátního propojení spravovaný vyhledávací službou.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti prostředku sdíleného privátního propojení spravovaného vyhledávací službou.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

Objekt

Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného vyhledávací službou.

Name	Typ	Description
groupId	string	ID skupiny od poskytovatele prostředku, pro který je sdílený prostředek privátního propojení určený.
privateLinkResourceId	string	ID prostředku prostředku, pro který je sdílený prostředek privátního propojení.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.
requestMessage	string	Zpráva žádosti o schválení sdíleného prostředku privátního propojení.
resourceRegion	string	Volitelný. Můžete použít k určení umístění prostředku Azure Resource Manageru, ke kterému se má vytvořit sdílené privátní propojení. To se vyžaduje jenom pro prostředky, jejichž konfigurace DNS je regionální (například Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

SharedPrivateLinkResourceProvisioningState

Výčet

Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.

Hodnota	Description
Deleting
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

Výčet

Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota	Description
Approved
Disconnected
Pending
Rejected

Sku

Objekt

Definuje skladovou položku vyhledávací služby, která určuje fakturační sazbu a limity kapacity.

Name	Typ	Description
name	SkuName	Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů.

SkuName

Výčet

Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů.

Hodnota	Description
basic	Fakturovatelná úroveň pro vyhrazenou službu, která má až 3 repliky.
free	Úroveň Free bez záruk SLA a podmnožina funkcí nabízených na fakturovatelných úrovních
standard	Fakturovatelná úroveň pro vyhrazenou službu, která má až 12 oddílů a 12 replik.
standard2	Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání.
standard3	Největší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity).
storage_optimized_l1	Fakturovatelná úroveň pro vyhrazenou službu, která podporuje 1 TB na oddíl, až 12 oddílů.
storage_optimized_l2	Fakturovatelná úroveň pro vyhrazenou službu, která podporuje 2 TB na oddíl, až 12 oddílů.