Services - Get

Referens

Tjänst:: Search Management

API-version:: 2024-03-01-preview

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=2024-03-01-preview

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	Namnet på Den Azure AI-tjänsten Search som är associerad med den angivna resursgruppen. Reguljärt uttrycksmönster: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
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 detta 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

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

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/preview/2024-03-01-preview/examples/SearchGetService.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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{
	// 		AuthOptions: &armsearch.DataPlaneAuthOptions{
	// 			APIKeyOnly: map[string]any{
	// 			},
	// 		},
	// 		DisableLocalAuth: to.Ptr(false),
	// 		DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
	// 		},
	// 		EncryptionWithCmk: &armsearch.EncryptionWithCmk{
	// 			EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
	// 			Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
	// 		},
	// 		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),
	// 		SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
	// 		},
	// 		Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 		StatusDetails: to.Ptr(""),
	// 	},
	// 	SKU: &armsearch.SKU{
	// 		Name: to.Ptr(armsearch.SKUNameStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the search service with the given name in the given resource group.
 *
 * @summary Gets the search service with the given name in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetService.json
 */
async function searchGetService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.get(resourceGroupName, searchServiceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SearchServiceResource
SearchServiceCollection collection = resourceGroupResource.GetSearchServices();

// invoke the operation
string searchServiceName = "mysearchservice";
NullableResponse<SearchServiceResource> response = await collection.GetIfExistsAsync(searchServiceName);
SearchServiceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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

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,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

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.
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 detta om "disableLocalAuth" är inställt på true.
EncryptionWithCmk	Beskriver en princip som bestämmer hur resurser i söktjänsten ska krypteras med kundhanterade nycklar.
HostingMode	Gäller endast för standard3 SKU. Du kan ange 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 standard3 SKU ä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	Den typ av identitet som används för resursen. 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-tjänsten Search.
NetworkRuleSet	Nätverksspecifika regler som avgör hur Azure AI-tjänsten Search kan nås.
PrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
PrivateEndpointConnection	Beskriver en befintlig privat slutpunktsanslutning till Azure AI-tjänsten Search.
PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.
PrivateLinkServiceConnectionProvisioningState	Etableringstillståndet för den privata länktjänstens anslutning. 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änstens anslutning. 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 "succeeded" eller "failed". 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".
SearchDisabledDataExfiltrationOption	En lista över dataexfiltreringsscenarier 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å objekt som inte är CMK-krypterade. Om en tjänst har fler än ett okrypterat objekt och framtvingande ä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 SKU:er för Azure AI Search på vissa platser.
SearchService	Beskriver en Azure AI-tjänsten Search och dess aktuella tillstånd.
SearchServiceStatus	Söktjänstens status. 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 degraderat, inaktiverat eller feltillstånd 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-tjänsten Search.
SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI-tjänsten Search.
SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för den delade privata länken. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
SharedPrivateLinkResourceStatus	Status för resursen för den delade privata länken. 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 kapacitetsgränser.
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 på "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."
UserAssignedManagedIdentity	Information om den användartilldelade hanterade identiteten som tilldelats söktjänsten.

AadAuthFailureMode

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

Name	Typ	Description
http401WithBearerChallenge	string	Anger att begäranden om misslyckad autentisering ska visas med en HTTP-statuskod på 401 (obehörig) och presentera en ägarutmaning.
http403	string	Anger att begäranden om misslyckad autentisering ska visas med http-statuskoden 403 (förbjuden).

ApiKeyOnly

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

CloudError

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

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 innehåller felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

DataPlaneAadOrApiKeyAuthOption

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

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

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

Beskriver en princip som bestämmer 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å objekt som inte är CMK-krypterade. Om en tjänst har fler än ett okrypterat objekt och framtvingande ä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

Gäller endast för standard3 SKU. Du kan ange 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 standard3 SKU är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

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

Identity

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 för söktjänstens systemtilldelade identitet.
tenantId	string	Klientorganisations-ID för söktjänstens systemtilldelade identitet.
type	IdentityType	Den typ av identitet som används för resursen. 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, UserAssignedManagedIdentity>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Den typ av identitet som används för resursen. 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.

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

IpRule

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

Name	Typ	Description
value	string	Värde som motsvarar en enda 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

Nätverksspecifika regler som avgör hur Azure AI-tjänsten Search 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 de inkommande nätverken 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 offentligt gränssnitt ens med några offentliga IP-regler, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.

PrivateEndpoint

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

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

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till Azure AI-tjänsten Search.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

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änstens anslutning. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades, Ofullständig eller Avbruten.

PrivateLinkServiceConnectionProvisioningState

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

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

PrivateLinkServiceConnectionState

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änstens anslutning. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

PrivateLinkServiceConnectionStatus

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

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

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 "succeeded" eller "failed". 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.

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

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.

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

SearchBypass

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

Name	Typ	Description
AzurePortal	string	Anger att begäranden som kommer från Azure Portal kan kringgå de regler som definieras i avsnittet "ipRules".
None	string	Anger att inget ursprung kan kringgå reglerna som definieras i avsnittet "ipRules". Det här är standardinställningen.

SearchDisabledDataExfiltrationOption

En lista över dataexfiltreringsscenarier 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.

Name	Typ	Description
All	string	Anger att alla scenarier för dataexfiltrering är inaktiverade.

SearchEncryptionComplianceStatus

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

Name	Typ	Description
Compliant	string	Anger att söktjänsten är kompatibel, antingen på grund av att antalet icke-CMK-krypterade objekt är noll eller att framtvingande är inaktiverat.
NonCompliant	string	Anger att söktjänsten har fler än ett icke-CMK-krypterat objekt.

SearchEncryptionWithCmk

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

Name	Typ	Description
Disabled	string	Ingen tillämpning av kundhanterad nyckelkryptering görs. Endast den inbyggda tjänsthanterade krypteringen används.
Enabled	string	tjänsten Search markeras som icke-kompatibla om ett eller flera objekt inte krypteras med en kundhanterad nyckel.
Unspecified	string	Tvingande princip har inte uttryckligen angetts, och beteendet är detsamma som om det hade angetts till "Inaktiverad".

SearchSemanticSearch

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

Name	Typ	Description
disabled	string	Anger att semantisk reranker är inaktiverad för söktjänsten. Det här är standardinställningen.
free	string	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. Detta är standard för nyligen etablerade söktjänster.
standard	string	Aktiverar semantisk reranker för en söktjänst som en fakturerbar funktion, med högre dataflöde och volym av semantiskt rangordnade frågor.

SearchService

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

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Resursens identitet.
location	string		Den geo-plats där resursen finns
name	string		Namnet på resursen
properties.authOptions	DataPlaneAuthOptions		Definierar alternativen för hur dataplanets API för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på true.
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.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		En lista över dataexfiltreringsscenarier som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värdet som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
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.hostingMode	HostingMode	default	Gäller endast för standard3 SKU. Du kan ange 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 standard3 SKU ä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-tjänsten Search kan nås.
properties.partitionCount	integer	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-tjänsten Search.
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 när tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "succeeded" eller "failed". 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	1	Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 för standard-SKU:er eller mellan 1 och 3 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.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Listan över delade privata länkresurser som hanteras av Azure AI-tjänsten Search.
properties.status	SearchServiceStatus		Söktjänstens status. 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 degraderat, inaktiverat eller feltillstånd 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.
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.
tags	object		Resurstaggar.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Söktjänstens status. 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 degraderat, inaktiverat eller feltillstånd 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.

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

SharedPrivateLinkResource

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

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en delad privat länkresurs som hanteras av Azure AI-tjänsten Search.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

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

Name	Typ	Description
groupId	string	Grupp-ID:t från resursprovidern som den delade privata länkresursen är till för.
privateLinkResourceId	string	Resurs-ID för resursen som den delade privata länkresursen är för.
provisioningState	SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för den delade privata länken. 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 plats 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 för resursen för den delade privata länken. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för den delade privata länken. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

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

SharedPrivateLinkResourceStatus

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

Name	Typ	Description
Approved	string	Resursen för den delade privata länken är godkänd och är redo att användas.
Disconnected	string	Resursen för den delade privata länken har tagits bort från tjänsten.
Pending	string	Resursen för den delade privata länken har skapats och väntar på godkännande.
Rejected	string	Resursen för den delade privata länken har avvisats och kan inte användas.

Sku

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

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

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

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

UserAssignedManagedIdentity

Information om den användartilldelade hanterade identiteten som tilldelats söktjänsten.

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

Dela via

Services - Get

URI-parametrar

Begärandehuvud

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

SearchGetService

Exempelbegäran

Exempelsvar

Definitioner

AadAuthFailureMode

ApiKeyOnly

CloudError

CloudErrorBody

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

HostingMode

Identity

IdentityType

IpRule

NetworkRuleSet

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SearchBypass

SearchDisabledDataExfiltrationOption

SearchEncryptionComplianceStatus

SearchEncryptionWithCmk

SearchSemanticSearch

SearchService

SearchServiceStatus

SharedPrivateLinkResource

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceProvisioningState

SharedPrivateLinkResourceStatus

Sku

SkuName

UserAssignedManagedIdentity

Ytterligare resurser