Services - Get

Služba:: Search Management

Verze rozhraní API:: 2025-05-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=2025-05-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Název služby Azure AI Search přidružené k zadané skupině prostředků.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

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	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory 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

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().Get(ctx, "rg1", "mysearchservice", 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 = armsearch.ServicesClientGetResponse{
	// 	Service: &armsearch.Service{
	// 		Name: to.Ptr("mysearchservice"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsearch.ServiceProperties{
	// 			AuthOptions: &armsearch.DataPlaneAuthOptions{
	// 				APIKeyOnly: map[string]any{
	// 				},
	// 			},
	// 			ComputeType: to.Ptr(armsearch.ComputeTypeDefault),
	// 			DataExfiltrationProtections: []*armsearch.SearchDataExfiltrationProtection{
	// 			},
	// 			DisableLocalAuth: to.Ptr(false),
	// 			EncryptionWithCmk: &armsearch.EncryptionWithCmk{
	// 				EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
	// 				Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
	// 			},
	// 			Endpoint: to.Ptr("https://mysearchservice.search.windows.net/"),
	// 			HostingMode: to.Ptr(armsearch.HostingModeDefault),
	// 			NetworkRuleSet: &armsearch.NetworkRuleSet{
	// 				Bypass: to.Ptr(armsearch.SearchBypassNone),
	// 				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),
	// 			ServiceUpgradedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-05-01T00:00:00Z"); return t}()),
	// 			SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
	// 			},
	// 			Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 			StatusDetails: to.Ptr(""),
	// 			UpgradeAvailable: to.Ptr(armsearch.UpgradeAvailableNotAvailable),
	// 		},
	// 		SKU: &armsearch.SKU{
	// 			Name: to.Ptr(armsearch.SKUNameStandard),
	// 		},
	// 		SystemData: &armsearch.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-01-01T00:00:00Z"); return t}()),
	// 			CreatedBy: to.Ptr("My e-commerce app"),
	// 			CreatedByType: to.Ptr(armsearch.CreatedByTypeApplication),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-11-01T00:00:00Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("fakeuser@contoso.com"),
	// 			LastModifiedByType: to.Ptr(armsearch.CreatedByTypeUser),
	// 		},
	// 		Tags: map[string]*string{
	// 			"app-name": to.Ptr("My e-commerce app"),
	// 		},
	// 	},
	// }
}

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

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "succeeded",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": "2025-05-01T00:00:00Z",
    "sharedPrivateLinkResources": [],
    "status": "running",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

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í.
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
ComputeType	Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo důvěrného výpočetního prostředí Azure.
createdByType	Typ identity, která prostředek vytvořila.
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. Pro skladovou položku standard3 je hodnota buď "Default" nebo "HighDensity". U všech ostatních skladových položek musí být tato hodnota Výchozí.
Identity	Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu.
IdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby.
IpRule	Pravidlo omezení IP služby Azure AI Search.
NetworkRuleSet	Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.
PrivateEndpointConnection	Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.
PrivateEndpointConnectionProperties	Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.
PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.
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 Selhání. 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ěch 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 lze nastavit na "Povoleno", aby nedocházelo k zásadním změnám ve stávajících zákaznických zdrojích a šablonách. 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.
SearchBypass	Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules".
SearchDataExfiltrationProtection	Specifický scénář exfiltrace dat, který je pro službu deaktivován.
SearchEncryptionComplianceStatus	Vrátí stav dodržování předpisů vyhledávací služby s ohledem na nešifrované objekty CMK. Pokud má služba více než jeden nešifrovaný objekt a je povoleno vynucování, služba se označí jako nedodržující předpisy.
SearchEncryptionWithCmk	Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem.
SearchSemanticSearch	Specifikuje dostupnost a fakturační plán pro sémantické vyhledávání ve službě Azure AI Search. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech.
SearchService	Popisuje službu Azure AI Search 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. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje 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 sdílený prostředek privátního propojení spravovaný službou Azure AI Search.
SharedPrivateLinkResourceProperties	Popisuje vlastnosti existujícího sdíleného prostředku privátního propojení spravovaného službou Azure AI Search.
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 2TB na oddíl, až 12 oddílů. 'serverless': Serverless tier s automatickým škálováním.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UpgradeAvailable	Uvádí, zda má specializovaná vyhledávací služba k dispozici upgrade.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem

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

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.
message	string	Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

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ě).

ComputeType

Výčet

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo důvěrného výpočetního prostředí Azure.

Hodnota	Description
Default	Vytvořte službu s výchozím výpočetním prostředím.
Confidential	Vytvořte dedikovanou službu pomocí Azure Confidential Compute.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

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		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	Vrátí stav dodržování předpisů vyhledávací služby s ohledem na nešifrované objekty CMK. Pokud má služba více než jeden nešifrovaný objekt a je povoleno vynucování, služba se označí jako nedodržující předpisy.
enforcement	SearchEncryptionWithCmk	Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného 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. Pro skladovou položku standard3 je hodnota buď "Default" nebo "HighDensity". U všech ostatních skladových položek musí být tato hodnota Výchozí.

Hodnota	Description
Default	Maximální limit indexů je určen SKU nebo cenovou vrstvou.
HighDensity	Platí pouze pro standardní standardní 3 (S3) SKU, kde vyhledávací služby mohou mít až 1 000 indexů.

Identity

Objekt

Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu.

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 používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby.
userAssignedIdentities	<string, UserAssignedIdentity>	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

IdentityType

Výčet

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby.

Hodnota	Description
None	Označuje, že každou identitu přidruženou k vyhledávací službě je potřeba odebrat.
SystemAssigned	Označuje, že bude povolena identita přiřazená systémem pro vyhledávací službu.
UserAssigned	Označuje, že k vyhledávací službě se přiřadí jedna nebo více identit přiřazených uživatelem.
SystemAssigned, UserAssigned	Označuje, že identita přiřazená systémem pro vyhledávací službu bude povolena spolu s přiřazením jedné nebo více identit přiřazených uživatelem.

IpRule

Objekt

Pravidlo omezení IP služby Azure AI Search.

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

NetworkRuleSet

Objekt

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

Name	Typ	Description
bypass	SearchBypass	Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules".
ipRules	IpRule[]	Seznam pravidel omezení PROTOKOLU IP, která definují příchozí sítě s povolením přístupu ke koncovému bodu vyhledávací služby. Mezitím brána firewall blokuje všechny ostatní veřejné IP sítě. Tato pravidla omezení se použijí pouze v případech, kdy je povolená "publicNetworkAccess" vyhledávací služby; jinak provoz přes veřejné rozhraní není povolen ani s pravidly veřejné IP adresy a připojení privátních koncových bodů by byla výhradní metodou přístupu.

PrivateEndpointConnection

Objekt

Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Napří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 ke službě Azure AI Search.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
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 prostředku Azure, pro který je služba private link určená.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Objekt

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

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

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Objekt

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

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

PrivateLinkServiceConnectionProvisioningState

Výčet

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

Hodnota	Description
Updating	Připojení služby Private Link probíhá v procesu vytváření spolu s dalšími prostředky, aby bylo plně funkční.
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.
Succeeded	Připojení služby Private Link dokončilo zřizování a je připravené ke schválení.
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.
Canceled	Žádost o zřízení prostředku připojení služby Private Link byla zrušena.

PrivateLinkServiceConnectionStatus

Výčet

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

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

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 Selhání. 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ěch 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
succeeded	Poslední operace zřizování byla úspěšně dokončena.
provisioning	Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. Pouze pro specializované vyhledávací služby.
failed	Poslední operace zřizování selhala.

PublicNetworkAccess

Výčet

Tuto hodnotu lze nastavit na "Povoleno", aby nedocházelo k zásadním změnám ve stávajících zákaznických zdrojích a šablonách. 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.

Hodnota	Description
Enabled	Vyhledávací služba je přístupná z provozu pocházejícího z veřejného internetu.
Disabled	Vyhledávací služba není přístupná z provozu pocházejícího z veřejného internetu. Přístup je povolený jenom přes schválená připojení privátních koncových bodů.
SecuredByPerimeter	Pravidla pro konfiguraci perimetru zabezpečení sítě umožňují nebo zakazují veřejný přístup k tomuto zdroji. Vyžaduje přidružený bezpečnostní perimetr sítě.

SearchBypass

Výčet

Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules".

Hodnota	Description
None	Označuje, že žádný zdroj nemůže obejít pravidla definovaná v části "ipRules". Toto je výchozí hodnota.
AzureServices	Označuje, že požadavky pocházející z důvěryhodných služeb Azure můžou obejít pravidla definovaná v části "ipRules".

SearchDataExfiltrationProtection

Výčet

Specifický scénář exfiltrace dat, který je pro službu deaktivován.

Hodnota	Description
BlockAll	Označuje, že všechny scénáře exfiltrace dat jsou zakázané.

SearchEncryptionComplianceStatus

Výčet

Vrátí stav dodržování předpisů vyhledávací služby s ohledem na nešifrované objekty CMK. Pokud má služba více než jeden nešifrovaný objekt a je povoleno vynucování, 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ď proto, že počet nešifrovaných objektů CMK je nula nebo je zakázáno vynucování.
NonCompliant	Označuje, že vyhledávací služba má více než jeden objekt bez šifrování CMK.

SearchEncryptionWithCmk

Výčet

Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem.

Hodnota	Description
Disabled	Nebude provedeno žádné vynucování šifrování klíčů spravovaných zákazníkem. Používá se pouze integrované šifrování spravované službou.
Enabled	Vyhledávací služba se označí jako nevyhovující, pokud jeden nebo více objektů není šifrované pomocí klíče spravovaného 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

Specifikuje dostupnost a fakturační plán pro sémantické vyhledávání ve službě Azure AI Search. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech.

Hodnota	Description
disabled	Označuje, že sémantický reranker je pro vyhledávací službu zakázaný.
free	Povolí sémantickou reranker ve vyhledávací službě a indikuje, že se má používat v rámci limitů bezplatného plánu. Bezplatný plán 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. Toto je výchozí hodnota.
standard	Umožňuje sémantický reranker ve vyhledávací službě jako fakturovatelnou funkci po vyčerpání bezplatné kvóty, s vyšší propustností a objemem sémanticky přeřazených dotazů.

SearchService

Objekt

Popisuje službu Azure AI Search a její aktuální stav.

Name	Typ	Default value	Description
id	string (arm-id)		Plně kvalifikované ID prostředku pro prostředek. Napří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.computeType	ComputeType		Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo důvěrného výpočetního prostředí Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.
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.eTag	string		Systém vygenerovaná vlastnost představující jmenovku služby, která může být pro řízení optimistické souběžnosti během aktualizací.
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.endpoint	string (uri)		Koncový bod služby Azure AI Search.
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. Pro skladovou položku standard3 je hodnota buď "Default" nebo "HighDensity". U všech ostatních skladových položek musí být tato hodnota Výchozí.
properties.networkRuleSet	NetworkRuleSet		Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Počet oddílů v dedikované vyhledávací službě; pokud je uvedeno, 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ů ke službě Azure AI Search.
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 Selhání. 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ěch 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 lze nastavit na "Povoleno", aby nedocházelo k zásadním změnám ve stávajících zákaznických zdrojích a šablonách. 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 (int32) minimum: 1 maximum: 12	1	Počet replik v dedikované 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		Specifikuje dostupnost a fakturační plán pro sémantické vyhledávání ve službě Azure AI Search. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech.
properties.serviceUpgradedAt	string (date-time)		Datum a čas posledního upgradu vyhledávací služby. Toto pole bude null, dokud se služba poprvé neupgraduje.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Seznam sdílených prostředků privátního propojení spravovaných službou Azure AI Search
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. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje 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.
properties.upgradeAvailable	UpgradeAvailable		Označuje, jestli má vyhledávací služba k dispozici upgrade.
sku	Sku		Skladová položka vyhledávací služby, která určuje cenové úrovně a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.
systemData	systemData		Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
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. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje 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
running	Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování.
provisioning	Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů.
deleting	Vyhledávací služba se odstraňuje.
degraded	Vyhledávací služba je degradovaná, protože základní jednotky vyhledávání nejsou v pořádku.
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.
stopped	Vyhledávací služba je v předplatném, které je zakázané.

SharedPrivateLinkResource

Objekt

Popisuje sdílený prostředek privátního propojení spravovaný službou Azure AI Search.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Napří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 službou Azure AI Search.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
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 privátního propojení spravovaného službou Azure AI Search.

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 pro žádost o schválení sdíleného prostředku privátního propojení.
resourceRegion	string	Volitelný. Dá se použít k určení umístění prostředku Azure Resource Manageru, pro který se vytváří 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
Updating	Sdílený prostředek privátního propojení probíhá při vytváření společně s dalšími prostředky, aby byl plně funkční.
Deleting	Sdílený prostředek privátního propojení probíhá v procesu odstranění.
Failed	Prostředek sdíleného privátního propojení se nepodařilo zřídit nebo odstranit.
Succeeded	Prostředek sdíleného privátního propojení dokončil zřizování a je připravený ke schválení.
Incomplete	Žádost o zřízení pro sdílený prostředek privátního propojení byla přijata, ale proces vytvoření ještě nebyl zahájen.

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
Pending	Byl vytvořen sdílený prostředek privátního propojení a čeká na schválení.
Approved	Sdílený prostředek privátního propojení je schválený a je připravený k použití.
Rejected	Sdílený prostředek privátního propojení byl odmítnut a nelze jej použít.
Disconnected	Sdílený prostředek privátního propojení byl ze služby odebrán.

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 2TB na oddíl, až 12 oddílů. 'serverless': Serverless tier s automatickým škálováním.

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 2TB na oddíl, až 12 oddílů. 'serverless': Serverless tier s automatickým škálováním.

Hodnota	Description
free	Úroveň Free bez záruk SLA a podmnožina funkcí nabízených na fakturovatelných úrovních
basic	Fakturovatelná úroveň pro vyhrazenou službu, která má až 3 repliky.
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ů.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UpgradeAvailable

Výčet

Uvádí, zda má specializovaná vyhledávací služba k dispozici upgrade.

Hodnota	Description
notAvailable	Pro tuto dedikovanou službu momentálně není k dispozici žádná modernizace.
available	Pro tuto dedikovanou službu je k dispozici i upgrade.

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string (uuid)	ID klienta přiřazené identity.
principalId	string (uuid)	ID objektu zabezpečení přiřazené identity.