Services - Get

Service:

Search Management

API Version:

2023-11-01

Získá vyhledávací službu se zadaný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 rámci aktuálního předplatného. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager nebo z 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 Manager, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro jednotlivé požadavky.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	Hodnota identifikátoru GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je tato možnost zadána, bude zahrnuta v informacích o odpovědi jako způsob, jak sledovat požadavek.

Odpovědi

Name	Typ	Description
200 OK	SearchService	Definice vyhledávací služby se úspěšně načetla a je v odpovědi. Pokud se dotazujete na 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 (Nenalezeno): Nepodařilo se najít předplatné, skupinu prostředků nebo název vyhledávací služby.

Zabezpečení

azure_auth

Microsoft Entra ID tok autorizace OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Příklady

SearchGetService

Sample Request

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

Definice

Name	Description
AadAuthFailureMode	Popisuje, jakou odpověď by rozhraní API roviny dat vyhledávací služby odeslalo na 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 hodnotu nelze nastavit, pokud je vlastnost 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í jenom pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby povolila 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. Pro skladovou položku Standard3 je 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í IP adresy vyhledávací služby.
NetworkRuleSet	Pravidla specifická pro síť, která určují, jak bude vyhledávací služba dostupná.
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, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.
PrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Private Link Service k privátnímu koncovému bodu Azure.
PrivateLinkServiceConnectionStatus	Stav připojení služby private link. Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.
ProvisioningState	Stav poslední operace zřizování provedené 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 provisioningState změní na "succeeded" nebo "failed". Klientské aplikace můžou stav zřizování dotazování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Získat vyhledávací službu zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, má tato hodnota tendenci se vracet jako "úspěch" přímo ve volání vytvořit vyhledávací službu. Je to proto, že bezplatná služba využívá kapacitu, která je už nastavená.
PublicNetworkAccess	Tuto hodnotu je možné nastavit na povoleno, aby nedošlo k zásadním změnám u existujících prostředků a šablon zákazníků. Pokud je nastavená hodnota zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátních koncových bodů by byla výhradní metodou přístupu.
SearchEncryptionComplianceStatus	Popisuje, jestli vyhledávací služba dodržuje předpisy, pokud jde o prostředky, které nejsou šifrované zákazníkem. Pokud má služba více prostředků, které nejsou šifrované zákazníkem, a vynucení je povolené, označí se jako nedodržující předpisy.
SearchEncryptionWithCmk	Popisuje, jak by vyhledávací služba měla vynucovat jeden nebo více prostředků neš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ří: "spuštěno": 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 vertikálně načítá 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í jednotky vyhledávání nejsou v pořádku. Vyhledávací služba je s největší pravděpodobností funkční, ale výkon může být pomalý a některé požadavky můžou být zahozeny. 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 v chybovém stavu. Pokud je vaše služba v sníženém, zakázaném nebo chybovém stavu, Microsoft aktivně prošetřuje související problém. Vyhrazené služby v těchto stavech se stále účtují na základě počtu zřízených jednotek vyhledávání.
SharedPrivateLinkResource	Popisuje sdílený Private Link prostředek 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í prostředku sdíleného privátního propojení Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.
SharedPrivateLinkResourceStatus	Stav prostředku sdíleného privátního propojení Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.
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ší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud také nastavíte 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

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

Name	Typ	Description
http401WithBearerChallenge	string	Označuje, že požadavky, které selhaly při ověřování, by se měly zobrazit se stavovým kódem HTTP 401 (Neautorizováno) a měly by představovat výzvu Bearer.
http403	string	Označuje, že požadavkům, které selhaly ověřování, by se měl zobrazit stavový kód HTTP 403 (Zakázáno).

ApiKeyOnly

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

CloudError

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

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

Name	Typ	Description
code	string	Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které s touto chybou souvisejí.
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

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, jakou odpověď by rozhraní API roviny dat vyhledávací služby odeslalo na požadavky, které selhaly při ověřování.

DataPlaneAuthOptions

Definuje možnosti, jak Vyhledávací služba ověřuje požadavek roviny dat. Tuto hodnotu nelze nastavit, pokud je vlastnost 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

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, pokud jde o prostředky, které nejsou šifrované zákazníkem. Pokud má služba více prostředků, které nejsou šifrované zákazníkem, a vynucení je povolené, označí se jako nedodržující předpisy.
enforcement	SearchEncryptionWithCmk	Popisuje, jak by vyhledávací služba měla vynucovat jeden nebo více prostředků nešifrovaných zákazníkem.

HostingMode

Platí jenom pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby povolila 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. Pro skladovou položku Standard3 je hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

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

Identity

Identita prostředku.

Name	Typ	Description
principalId	string	Hlavní ID 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

Typ identity.

Name	Typ	Description
None	string
SystemAssigned	string

IpRule

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

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

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak bude vyhledávací služba dostupná.

Name	Typ	Description
ipRules	IpRule[]	Seznam pravidel omezení IP adres 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í pouze v případech, kdy je povolená možnost publicNetworkAccess vyhledávací služby.

PrivateEndpoint

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

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 Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
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

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.
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 Service k privátnímu koncovému bodu Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby private link. Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.

PrivateLinkServiceConnectionProvisioningState

Stav zřizování připojení služby private link. Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.

Name	Typ	Description
Canceled	string	Žádost o zřízení prostředku připojení služby private link se zrušila.
Deleting	string	Připojení služby private link se právě odstraňuje.
Failed	string	Připojení služby private link se nepodařilo zřídit nebo odstranit.
Incomplete	string	Žádost o zřízení pro prostředek připojení služby private link byla přijata, ale proces vytváření ještě nebyl zahájen.
Succeeded	string	Připojení služby Private Link dokončilo zřizování a je připravené ke schválení.
Updating	string	Připojení služby Private Link se vytváří společně s dalšími prostředky, aby bylo plně funkční.

PrivateLinkServiceConnectionState

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

Name	Typ	Výchozí hodnota	Description
actionsRequired	string	None	Popis všech další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áleno, Odmítnuto nebo Odpojeno.

PrivateLinkServiceConnectionStatus

Stav připojení služby private link. Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.

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

ProvisioningState

Stav poslední operace zřizování provedené 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 provisioningState změní na "succeeded" nebo "failed". Klientské aplikace můžou stav zřizování dotazování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Získat vyhledávací službu zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, má tato hodnota tendenci se vracet jako "úspěch" přímo ve volání vytvořit vyhledávací službu. Je to proto, že bezplatná služba využívá kapacitu, která je už nastavená.

Name	Typ	Description
failed	string	Poslední operace zřizování selhala.
provisioning	string	Vyhledávací služba se zřizuje nebo vertikálně navyšuje nebo snižuje kapacitu.
succeeded	string	Poslední operace zřizování byla úspěšně dokončena.

PublicNetworkAccess

Tuto hodnotu je možné nastavit na povoleno, aby nedošlo k zásadním změnám u existujících prostředků a šablon zákazníků. Pokud je nastavená hodnota zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátních koncových bodů by byla výhradní metodou přístupu.

Name	Typ	Description
disabled	string
enabled	string

SearchEncryptionComplianceStatus

Popisuje, jestli vyhledávací služba dodržuje předpisy, pokud jde o prostředky, které nejsou šifrované zákazníkem. Pokud má služba více prostředků, které nejsou šifrované zákazníkem, a vynucení je povolené, označí se jako nedodržující předpisy.

Name	Typ	Description
Compliant	string	Označuje, že vyhledávací služba vyhovuje předpisům, protože počet prostředků nešifrovaných zákazníkem je nulový, nebo je zakázáno vynucování.
NonCompliant	string	Označuje, že vyhledávací služba má více prostředků, které nejsou šifrované zákazníkem.

SearchEncryptionWithCmk

Popisuje, jak by vyhledávací služba měla vynucovat jeden nebo více prostředků nešifrovaných zákazníkem.

Name	Typ	Description
Disabled	string	Nebude provedeno žádné vynucování a vyhledávací služba může mít prostředky, které nejsou šifrované zákazníkem.
Enabled	string	Search se označí jako nevyhovující, pokud existuje jeden nebo více prostředků, které nejsou šifrované zákazníkem.
Unspecified	string	Zásady vynucení nejsou explicitně zadané, přičemž chování je stejné, jako kdyby bylo nastaveno na Zakázáno.

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.

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

SearchService

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

Name	Typ	Výchozí hodnota	Description
id	string		Plně kvalifikované ID prostředku. 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í prostředek
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 vlastnost disableLocalAuth nastavená na hodnotu true.
properties.disableLocalAuth	boolean		Pokud je nastavená hodnota true, volání vyhledávací služby nebudou moct využívat klíče rozhraní API k ověřování. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definována 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í jenom pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby povolila 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. Pro skladovou položku Standard3 je 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 může být vyhledávací služba přístupná.
properties.partitionCount	integer	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 hostovacímmodem 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í provedené 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 provisioningState změní na "succeeded" nebo "failed". Klientské aplikace můžou stav zřizování dotazování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Získat vyhledávací službu zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, má tato hodnota tendenci se vracet jako "úspěch" přímo ve volání vytvořit vyhledávací službu. Je to proto, že bezplatná služba využívá kapacitu, která je už nastavená.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Tuto hodnotu je možné nastavit na povoleno, aby nedošlo k zásadním změnám u existujících prostředků a šablon zákazníků. Pokud je nastavená hodnota zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátních koncových bodů by byla výhradní metodou přístupu.
properties.replicaCount	integer	1	Počet replik ve vyhledávací službě. Pokud je zadáno, musí to být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro skladovou položku Basic.
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 prostředků sdíleného privátního propojení spravovaných vyhledávací službou.
properties.status	SearchServiceStatus		Stav vyhledávací služby. Mezi možné hodnoty patří: "spuštěno": 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 vertikálně načítá 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í jednotky vyhledávání nejsou v pořádku. Vyhledávací služba je s největší pravděpodobností funkční, ale výkon může být pomalý a některé požadavky můžou být zahozeny. 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 v chybovém stavu. Pokud je vaše služba v sníženém, zakázaném nebo chybovém stavu, Microsoft aktivně prošetřuje související problém. Vyhrazené služby v těchto stavech se stále účtují 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

Stav vyhledávací služby. Mezi možné hodnoty patří: "spuštěno": 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 vertikálně načítá 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í jednotky vyhledávání nejsou v pořádku. Vyhledávací služba je s největší pravděpodobností funkční, ale výkon může být pomalý a některé požadavky můžou být zahozeny. 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 v chybovém stavu. Pokud je vaše služba v sníženém, zakázaném nebo chybovém stavu, Microsoft aktivně prošetřuje související problém. Vyhrazené služby v těchto stavech se stále účtují na základě počtu zřízených jednotek vyhledávání.

Name	Typ	Description
degraded	string	Vyhledávací služba je degradovaná, protože základní vyhledávací jednotky nejsou v pořádku.
deleting	string	Vyhledávací služba se odstraňuje.
disabled	string	Vyhledávací služba je zakázaná a všechny požadavky rozhraní API budou odmítnuty.
error	string	Vyhledávací služba je v chybovém stavu, což značí selhání zřízení nebo odstranění.
provisioning	string	Vyhledávací služba se zřizuje nebo vertikálně navyšuje nebo nabíná.
running	string	Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování.

SharedPrivateLinkResource

Popisuje sdílený Private Link prostředek spravovaný vyhledávací službou.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti sdíleného prostředku Private Link spravovaného vyhledávací službou.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

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 prostředek sdíleného privátního propojení určený.
privateLinkResourceId	string	ID prostředku, pro který je prostředek sdíleného privátního propojení určen.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stav zřizování prostředku sdíleného privátního propojení. Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.
requestMessage	string	Zpráva žádosti o schválení prostředku sdíleného privátního propojení.
resourceRegion	string	Nepovinný parametr. Dá se použít k určení umístění azure Resource Manager prostředku, ke kterému se má vytvořit sdílené privátní propojení. To se vyžaduje jenom u prostředků, jejichž konfigurace DNS je místní (například Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stav prostředku sdíleného privátního propojení Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.

SharedPrivateLinkResourceProvisioningState

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

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

SharedPrivateLinkResourceStatus

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

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

Sku

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ší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud také nastavíte 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

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ší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud také nastavíte 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ů.

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