Services - Get

Tjänst:

Search Management

API-version:

2025-05-01

Hämtar söktjänsten med det angivna namnet i den angivna resursgruppen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Namnet på azure AI Search-tjänsten som är associerad med den angivna resursgruppen.
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
api-version	query	True	string	DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name	Typ	Description
200 OK	SearchService	Söktjänstdefinitionen har hämtats och finns i svaret. Om du söker efter slutförandet av en etablerings- eller skalningsåtgärd kan du kontrollera dess status via egenskapen provisioningState.
Other Status Codes	CloudError	HTTP 404 (hittades inte): Det gick inte att hitta prenumerationen, resursgruppen eller söktjänstens namn.

Säkerhet

azure_auth

Anger ett implicit beviljandeflöde som stöds på Microsoft Identity-plattformen.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SearchGetService

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": "2025-05-01T00:00:00Z"
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

Definitioner

Name	Description
AadAuthFailureMode	Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.
ApiKeyOnly	Anger att endast API-nyckeln kan användas för autentisering.
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
ComputeType	Konfigurera den här egenskapen så att den stöder söktjänsten med hjälp av antingen Standardberäkning eller Konfidentiell Beräkning i Azure.
createdByType	Den typ av identitet som skapade resursen.
DataPlaneAadOrApiKeyAuthOption	Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID-klientorganisation kan användas för autentisering.
DataPlaneAuthOptions	Definierar alternativen för hur söktjänsten autentiserar en dataplansbegäran. Det går inte att ange om "disableLocalAuth" är inställt på sant.
EncryptionWithCmk	Beskriver en princip som avgör hur resurser i söktjänsten ska krypteras med kundhanterade nycklar.
HostingMode	Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".
Identity	Information om söktjänstens identitet. Ett null-värde anger att söktjänsten inte har någon tilldelad identitet.
IdentityType	The type of identity used for the resource. Typen "SystemAssigned, UserAssigned" innehåller både en identitet som skapats av systemet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
IpRule	IP-begränsningsregeln för Azure AI Search-tjänsten.
NetworkRuleSet	Nätverksspecifika regler som avgör hur Azure AI Search-tjänsten kan nås.
PrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
PrivateEndpointConnection	Beskriver en befintlig privat slutpunktsanslutning till Azure AI Search-tjänsten.
PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.
PrivateLinkServiceConnectionProvisioningState	Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades, Ofullständig eller Avbruten.
PrivateLinkServiceConnectionState	Beskriver det aktuella tillståndet för en befintlig Azure Private Link-tjänstanslutning till den privata slutpunkten.
PrivateLinkServiceConnectionStatus	Status för den privata länktjänstanslutningen. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.
ProvisioningState	Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "Lyckades" eller "Misslyckades". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "Lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.
PublicNetworkAccess	Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.
SearchBypass	Möjliga ursprung för inkommande trafik som kan kringgå de regler som definieras i avsnittet "ipRules".
SearchDataExfiltrationProtection	En lista över scenarier för dataexfiltrering som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
SearchEncryptionComplianceStatus	Returnerar status för söktjänstens kompatibilitet med avseende på icke-CMK-krypterade objekt. Om en tjänst har mer än ett okrypterat objekt och tvingande är aktiverat markeras tjänsten som inkompatibel.
SearchEncryptionWithCmk	Beskriver hur en söktjänst ska framtvinga efterlevnad om den hittar objekt som inte är krypterade med den kundhanterade nyckeln.
SearchSemanticSearch	Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure AI Search-SKU:er på vissa platser.
SearchService	Beskriver en Azure AI Search-tjänst och dess aktuella tillstånd.
SearchServiceStatus	Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. "etablering": Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel innebär det att Azure AI Search-teamet aktivt undersöker det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.
SharedPrivateLinkResource	Beskriver en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.
SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.
SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
SharedPrivateLinkResourceStatus	Status of the shared private link resource. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.
Sku	Definierar SKU:n för en söktjänst, som avgör faktureringshastighet och kapacitetsbegränsningar.
SkuName	SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UpgradeAvailable	Anger om söktjänsten har en tillgänglig uppgradering.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

AadAuthFailureMode

Uppräkning

Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

Värde	Description
http401WithBearerChallenge	Anger att begäranden om misslyckad autentisering ska visas med en HTTP-statuskod på 401 (obehörig) och presentera en Bearer Challenge.
http403	Anger att begäranden om misslyckad autentisering ska visas med en HTTP-statuskod på 403 (förbjuden).

ApiKeyOnly

Objekt

Anger att endast API-nyckeln kan användas för autentisering.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

ComputeType

Uppräkning

Konfigurera den här egenskapen så att den stöder söktjänsten med hjälp av antingen Standardberäkning eller Konfidentiell Beräkning i Azure.

Värde	Description
confidential	Skapa tjänsten med Azure Confidential Compute.
default	Skapa tjänsten med standardberäkningen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

DataPlaneAadOrApiKeyAuthOption

Objekt

Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID-klientorganisation kan användas för autentisering.

Name	Typ	Description
aadAuthFailureMode	AadAuthFailureMode	Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

DataPlaneAuthOptions

Objekt

Definierar alternativen för hur söktjänsten autentiserar en dataplansbegäran. Det går inte att ange om "disableLocalAuth" är inställt på sant.

Name	Typ	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID-klientorganisation kan användas för autentisering.
apiKeyOnly	ApiKeyOnly	Anger att endast API-nyckeln kan användas för autentisering.

EncryptionWithCmk

Objekt

Beskriver en princip som avgör hur resurser i söktjänsten ska krypteras med kundhanterade nycklar.

Name	Typ	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Returnerar status för söktjänstens kompatibilitet med avseende på icke-CMK-krypterade objekt. Om en tjänst har mer än ett okrypterat objekt och tvingande är aktiverat markeras tjänsten som inkompatibel.
enforcement	SearchEncryptionWithCmk	Beskriver hur en söktjänst ska framtvinga efterlevnad om den hittar objekt som inte är krypterade med den kundhanterade nyckeln.

HostingMode

Uppräkning

Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

Värde	Description
default	Gränsen för antalet index bestäms av standardgränserna för SKU:n.
highDensity	Endast program för standard3 SKU, där söktjänsten kan ha upp till 1 000 index.

Identity

Objekt

Information om söktjänstens identitet. Ett null-värde anger att söktjänsten inte har någon tilldelad identitet.

Name	Typ	Description
principalId	string	Huvud-ID:t för söktjänstens systemtilldelade identitet.
tenantId	string	Klientorganisations-ID för söktjänstens systemtilldelade identitet.
type	IdentityType	The type of identity used for the resource. Typen "SystemAssigned, UserAssigned" innehåller både en identitet som skapats av systemet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	<string,  UserAssignedIdentity>	The list of user identities associated with the resource. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Uppräkning

The type of identity used for the resource. Typen "SystemAssigned, UserAssigned" innehåller både en identitet som skapats av systemet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Värde	Description
None	Anger att alla identiteter som är associerade med söktjänsten måste tas bort.
SystemAssigned	Anger att systemtilldelad identitet för söktjänsten kommer att aktiveras.
SystemAssigned, UserAssigned	Anger att systemtilldelad identitet för söktjänsten aktiveras tillsammans med tilldelningen av en eller flera användartilldelade identiteter.
UserAssigned	Anger att en eller flera användartilldelade identiteter kommer att tilldelas till söktjänsten.

IpRule

Objekt

IP-begränsningsregeln för Azure AI Search-tjänsten.

Name	Typ	Description
value	string	Värde som motsvarar en enskild IPv4-adress (t.ex. 123.1.2.3) eller ett IP-intervall i CIDR-format (t.ex. 123.1.2.3/24) som ska tillåtas.

NetworkRuleSet

Objekt

Nätverksspecifika regler som avgör hur Azure AI Search-tjänsten kan nås.

Name	Typ	Description
bypass	SearchBypass	Möjliga ursprung för inkommande trafik som kan kringgå de regler som definieras i avsnittet "ipRules".
ipRules	IpRule[]	En lista över IP-begränsningsregler som definierar inkommande nätverk med åtkomst till söktjänstens slutpunkt. Under tiden blockeras alla andra offentliga IP-nätverk av brandväggen. Dessa begränsningsregler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad". Annars tillåts inte trafik via det offentliga gränssnittet ens med några offentliga IP-regler, och privata slutpunktsanslutningar skulle vara den exklusiva åtkomstmetoden.

PrivateEndpoint

Objekt

Den privata slutpunktsresursen från Microsoft.Network-providern.

Name	Typ	Description
id	string	Resurs-ID för den privata slutpunktsresursen från Microsoft.Network-providern.

PrivateEndpointConnection

Objekt

Beskriver en befintlig privat slutpunktsanslutning till Azure AI Search-tjänsten.

Name	Typ	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till Azure AI Search-tjänsten.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.

Name	Typ	Description
groupId	string	Grupp-ID för Den Azure-resurs som tjänsten private link är till för.
privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Beskriver det aktuella tillståndet för en befintlig Azure Private Link-tjänstanslutning till den privata slutpunkten.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades, Ofullständig eller Avbruten.

PrivateLinkServiceConnectionProvisioningState

Uppräkning

Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades, Ofullständig eller Avbruten.

Värde	Description
Canceled	Etableringsbegäran för den privata länktjänstens anslutningsresurs har avbrutits.
Deleting	Den privata länktjänstanslutningen håller på att tas bort.
Failed	Det gick inte att etablera eller ta bort den privata länktjänstens anslutning.
Incomplete	Etableringsbegäran för anslutningsresursen för den privata länktjänsten har godkänts, men processen för att skapa har inte påbörjats ännu.
Succeeded	Anslutningen till tjänsten private link har slutfört etableringen och är klar för godkännande.
Updating	Den privata länktjänstens anslutning håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.

PrivateLinkServiceConnectionState

Objekt

Beskriver det aktuella tillståndet för en befintlig Azure Private Link-tjänstanslutning till den privata slutpunkten.

Name	Typ	Standardvärde	Description
actionsRequired	string	None	En beskrivning av eventuella extra åtgärder som kan krävas.
description	string		Beskrivningen av anslutningstillståndet för tjänsten private link.
status	PrivateLinkServiceConnectionStatus		Status för den privata länktjänstanslutningen. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

PrivateLinkServiceConnectionStatus

Uppräkning

Status för den privata länktjänstanslutningen. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Värde	Description
Approved	Den privata slutpunktsanslutningen är godkänd och klar att användas.
Disconnected	Den privata slutpunktsanslutningen har tagits bort från tjänsten.
Pending	Den privata slutpunktsanslutningen har skapats och väntar på godkännande.
Rejected	Den privata slutpunktsanslutningen har avvisats och kan inte användas.

ProvisioningState

Uppräkning

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "Lyckades" eller "Misslyckades". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "Lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.

Värde	Description
failed	Den senaste etableringsåtgärden misslyckades.
provisioning	Söktjänsten etableras eller skalas upp eller ned.
succeeded	Den senaste etableringsåtgärden har slutförts.

PublicNetworkAccess

Uppräkning

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

Värde	Description
disabled	Söktjänsten är inte tillgänglig från trafik som kommer från det offentliga Internet. Åtkomst tillåts endast via godkända privata slutpunktsanslutningar.
enabled	Söktjänsten är tillgänglig från trafik som kommer från det offentliga Internet.

SearchBypass

Uppräkning

Möjliga ursprung för inkommande trafik som kan kringgå de regler som definieras i avsnittet "ipRules".

Värde	Description
AzureServices	Anger att begäranden som kommer från azure-betrodda tjänster kan kringgå de regler som definieras i avsnittet "ipRules".
None	Anger att inget ursprung kan kringgå de regler som definierats i avsnittet "ipRules". Det här är standardinställningen.

SearchDataExfiltrationProtection

Uppräkning

En lista över scenarier för dataexfiltrering som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.

Värde	Description
BlockAll	Anger att alla scenarier för dataexfiltrering är inaktiverade.

SearchEncryptionComplianceStatus

Uppräkning

Returnerar status för söktjänstens kompatibilitet med avseende på icke-CMK-krypterade objekt. Om en tjänst har mer än ett okrypterat objekt och tvingande är aktiverat markeras tjänsten som inkompatibel.

Värde	Description
Compliant	Anger att söktjänsten är kompatibel, antingen för att antalet icke-CMK-krypterade objekt är noll eller att tvingande är inaktiverat.
NonCompliant	Anger att söktjänsten har fler än ett icke-CMK-krypterat objekt.

SearchEncryptionWithCmk

Uppräkning

Beskriver hur en söktjänst ska framtvinga efterlevnad om den hittar objekt som inte är krypterade med den kundhanterade nyckeln.

Värde	Description
Disabled	Ingen tillämpning av kundhanterad nyckelkryptering görs. Endast den inbyggda tjänsthanterade krypteringen används.
Enabled	Söktjänsten markeras som icke-kompatibel om ett eller flera objekt inte krypteras med en kundhanterad nyckel.
Unspecified	Tvingande princip anges inte uttryckligen, och beteendet är detsamma som om det var inställt på "Inaktiverad".

SearchSemanticSearch

Uppräkning

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure AI Search-SKU:er på vissa platser.

Värde	Description
disabled	Anger att semantisk reranker är inaktiverad för söktjänsten. Det här är standardinställningen.
free	Aktiverar semantisk reranker på en söktjänst och anger att den ska användas inom gränserna för den kostnadsfria planen. Den kostnadsfria planen skulle begränsa volymen av semantiska rankningsförfrågningar och erbjuds utan extra kostnad. Det här är standardvärdet för nyligen etablerade söktjänster.
standard	Aktiverar semantisk reranker på en söktjänst som en fakturerbar funktion, med högre dataflöde och volym med semantiskt rangordnade frågor.

SearchService

Objekt

Beskriver en Azure AI Search-tjänst och dess aktuella tillstånd.

Name	Typ	Standardvärde	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		The identity of the resource.
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.authOptions	DataPlaneAuthOptions		Definierar alternativen för hur dataplans-API:et för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på sant.
properties.computeType	ComputeType		Konfigurera den här egenskapen så att den stöder söktjänsten med hjälp av antingen Standardberäkning eller Konfidentiell Beräkning i Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		En lista över scenarier för dataexfiltrering som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
properties.disableLocalAuth	boolean		När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.
properties.eTag	string		En systemgenererad egenskap som representerar tjänstens etag som kan vara för optimistisk samtidighetskontroll under uppdateringar.
properties.encryptionWithCmk	EncryptionWithCmk		Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.
properties.endpoint	string (uri)		Slutpunkten för Azure AI Search-tjänsten.
properties.hostingMode	HostingMode	default	Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".
properties.networkRuleSet	NetworkRuleSet		Nätverksspecifika regler som avgör hur Azure AI Search-tjänsten kan nås.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Listan över privata slutpunktsanslutningar till Azure AI Search-tjänsten.
properties.provisioningState	ProvisioningState		Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "Lyckades" eller "Misslyckades". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "Lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.
properties.semanticSearch	SearchSemanticSearch		Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure AI Search-SKU:er på vissa platser.
properties.serviceUpgradedAt	string (date-time)		Datum och tid då söktjänsten senast uppgraderades. Det här fältet är null tills tjänsten uppgraderas för första gången.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Listan över delade privata länkresurser som hanteras av Azure AI Search-tjänsten.
properties.status	SearchServiceStatus		Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. "etablering": Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel innebär det att Azure AI Search-teamet aktivt undersöker det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.
properties.statusDetails	string		Information om söktjänstens status.
properties.upgradeAvailable	UpgradeAvailable		Anger om söktjänsten har en tillgänglig uppgradering.
sku	Sku		SKU:n för söktjänsten, som avgör prisnivå och kapacitetsgränser. Den här egenskapen krävs när du skapar en ny söktjänst.
systemData	systemData		Azure Resource Manager-metadata för söktjänsten som innehåller createdBy och modifiedBy-information.
tags	object		Resursetiketter.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Uppräkning

Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. "etablering": Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel innebär det att Azure AI Search-teamet aktivt undersöker det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.

Värde	Description
degraded	Söktjänsten degraderas eftersom underliggande sökenheter inte är felfria.
deleting	Söktjänsten tas bort.
disabled	Söktjänsten är inaktiverad och alla API-begäranden avvisas.
error	Söktjänsten är i feltillstånd, vilket indikerar antingen att det inte gick att etablera eller att den skulle tas bort.
provisioning	Söktjänsten etableras eller skalas upp eller ned.
running	Söktjänsten körs och inga etableringsåtgärder pågår.
stopped	Söktjänsten finns i en prenumeration som är inaktiverad.

SharedPrivateLinkResource

Objekt

Beskriver en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.

Name	Typ	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Objekt

Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.

Name	Typ	Description
groupId	string	Grupp-ID:t från resursprovidern som resursen delad privat länk är till för.
privateLinkResourceId	string	Resurs-ID:t för resursen som resursen för den delade privata länken är till för.
provisioningState	SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
requestMessage	string	Meddelandet för att begära godkännande av resursen för delad privat länk.
resourceRegion	string	Valfritt. Kan användas för att ange Azure Resource Manager-platsen för resursen som en delad privat länk skapas för. Detta krävs endast för de resurser vars DNS-konfiguration är regional (till exempel Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status of the shared private link resource. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

SharedPrivateLinkResourceProvisioningState

Uppräkning

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

Värde	Description
Deleting	Resursen för delad privat länk håller på att tas bort.
Failed	Resursen för den delade privata länken kunde inte etableras eller tas bort.
Incomplete	Etableringsbegäran för resursen för delad privat länk har godkänts, men processen för att skapa har inte påbörjats ännu.
Succeeded	Resursen för delad privat länk har slutfört etableringen och är redo för godkännande.
Updating	Resursen för delad privat länk håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.

SharedPrivateLinkResourceStatus

Uppräkning

Status of the shared private link resource. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Värde	Description
Approved	Resursen för delad privat länk är godkänd och är redo att användas.
Disconnected	Resursen för delad privat länk har tagits bort från tjänsten.
Pending	Resursen för delad privat länk har skapats och väntar på godkännande.
Rejected	Resursen för delad privat länk har avvisats och kan inte användas.

Sku

Objekt

Definierar SKU:n för en söktjänst, som avgör faktureringshastighet och kapacitetsbegränsningar.

Name	Typ	Description
name	SkuName	SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.

SkuName

Uppräkning

SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.

Värde	Description
basic	Fakturerbar nivå för en dedikerad tjänst med upp till 3 repliker.
free	Kostnadsfri nivå, utan SLA-garantier och en delmängd av de funktioner som erbjuds på fakturerbara nivåer.
standard	Fakturerbar nivå för en dedikerad tjänst med upp till 12 partitioner och 12 repliker.
standard2	Liknar "standard", men med mer kapacitet per sökenhet.
standard3	Det största Standard-erbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity").
storage_optimized_l1	Fakturerbar nivå för en dedikerad tjänst som stöder 1 TB per partition, upp till 12 partitioner.
storage_optimized_l2	Fakturerbar nivå för en dedikerad tjänst som stöder 2 TB per partition, upp till 12 partitioner.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UpgradeAvailable

Uppräkning

Anger om söktjänsten har en tillgänglig uppgradering.

Värde	Description
available	Det finns en uppgradering tillgänglig för tjänsten.
notAvailable	En uppgradering är för närvarande inte tillgänglig för tjänsten.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.