Services - List By Subscription

Referens

Tjänst:: Search Management

API-version:: 2023-11-01

Hämtar en lista över alla söktjänster i den angivna prenumerationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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, kommandoradsverktygen 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	SearchServiceListResult	Åtgärden lyckades. Svaret innehåller listan över alla söktjänstdefinitioner för den angivna prenumerationen.
Other Status Codes	CloudError	Ett oväntat fel uppstod under åtgärden.

Säkerhet

azure_auth

Auktoriseringsflöde för Microsoft Entra ID OAuth2.

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SearchListServicesBySubscription

Exempelbegäran

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/searchServices?api-version=2023-11-01


/**
 * Samples for Services List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * SearchListServicesBySubscription.json
     */
    /**
     * Sample code: SearchListServicesBySubscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchListServicesBySubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().list(null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_list_services_by_subscription.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.json
func ExampleServicesClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewServicesClient().NewListBySubscriptionPager(&armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServiceListResult = armsearch.ServiceListResult{
		// 	Value: []*armsearch.Service{
		// 		{
		// 			Name: to.Ptr("mysearchservice"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"app-name": to.Ptr("My e-commerce app"),
		// 			},
		// 			Properties: &armsearch.ServiceProperties{
		// 				HostingMode: to.Ptr(armsearch.HostingModeDefault),
		// 				NetworkRuleSet: &armsearch.NetworkRuleSet{
		// 					IPRules: []*armsearch.IPRule{
		// 					},
		// 				},
		// 				PartitionCount: to.Ptr[int32](1),
		// 				PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
		// 				},
		// 				ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
		// 				ReplicaCount: to.Ptr[int32](3),
		// 				Status: to.Ptr(armsearch.SearchServiceStatusRunning),
		// 				StatusDetails: to.Ptr(""),
		// 			},
		// 			SKU: &armsearch.SKU{
		// 				Name: to.Ptr(armsearch.SKUNameStandard),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mysearchservice2"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Search/searchServices/mysearchservice2"),
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 				"app-name": to.Ptr("My e-commerce app"),
		// 			},
		// 			Properties: &armsearch.ServiceProperties{
		// 				HostingMode: to.Ptr(armsearch.HostingModeDefault),
		// 				NetworkRuleSet: &armsearch.NetworkRuleSet{
		// 					IPRules: []*armsearch.IPRule{
		// 					},
		// 				},
		// 				PartitionCount: to.Ptr[int32](1),
		// 				PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
		// 				},
		// 				ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
		// 				ReplicaCount: to.Ptr[int32](1),
		// 				Status: to.Ptr(armsearch.SearchServiceStatusRunning),
		// 				StatusDetails: to.Ptr(""),
		// 			},
		// 			SKU: &armsearch.SKU{
		// 				Name: to.Ptr(armsearch.SKUNameBasic),
		// 			},
		// 	}},
		// }
	}
}

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 a list of all Search services in the given subscription.
 *
 * @summary Gets a list of all Search services in the given subscription.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.json
 */
async function searchListServicesBySubscription() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.services.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

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

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.json
// this example is just showing the usage of "Services_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (SearchServiceResource item in subscriptionResource.GetSearchServicesAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

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

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 om "disableLocalAuth" är inställt på sant.
EncryptionWithCmk	Beskriver en princip som avgör hur resurser i söktjänsten ska krypteras med customer=managed keys.
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	Identitet för resursen.
IdentityType	Identitetstypen.
IpRule	Ip-begränsningsregeln för söktjänsten.
NetworkRuleSet	Nätverksspecifika regler som avgör hur söktjänsten kan nås.
PrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
PrivateEndpointConnection	Beskriver en befintlig privat slutpunktsanslutning till söktjä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 eller Ofullständig
PrivateLinkServiceConnectionState	Beskriver det aktuella tillståndet för en befintlig Private Link-tjänstanslutning till den privata Azure-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.
SearchEncryptionComplianceStatus	Beskriver om söktjänsten är kompatibel eller inte när det gäller att ha icke-kundkrypterade resurser. Om en tjänst har mer än en icke-kundkrypterad resurs och "Enforcement" är "aktiverad" markeras tjänsten som "icke-kompatibel".
SearchEncryptionWithCmk	Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.
SearchSemanticSearch	Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.
SearchService	Beskriver en söktjänst och dess aktuella tillstånd.
SearchServiceListResult	Svar som innehåller en lista över söktjänster.
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. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel undersöker Microsoft aktivt 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 söktjänsten.
SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av söktjä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 för resursen för delad privat länk. 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.

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.

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

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 customer=managed keys.

Name	Typ	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Beskriver om söktjänsten är kompatibel eller inte när det gäller att ha icke-kundkrypterade resurser. Om en tjänst har mer än en icke-kundkrypterad resurs och "Enforcement" är "aktiverad" markeras tjänsten som "icke-kompatibel".
enforcement	SearchEncryptionWithCmk	Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.

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

Identitet för resursen.

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

IdentityType

Uppräkning

Identitetstypen.

Värde	Description
None
SystemAssigned

IpRule

Objekt

Ip-begränsningsregeln för söktjänsten.

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

NetworkRuleSet

Objekt

Nätverksspecifika regler som avgör hur söktjänsten kan nås.

Name	Typ	Description
ipRules	IpRule[]	En lista över IP-begränsningsregler som används för en IP-brandvägg. Ip-adresser som inte matchar reglerna blockeras av brandväggen. Dessa regler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad".

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 söktjänsten.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.
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:t från resursprovidern som den privata länktjänstanslutningen ä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 Private Link-tjänstanslutning till den privata Azure-slutpunkten.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig

PrivateLinkServiceConnectionProvisioningState

Uppräkning

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

Värde	Description
Canceled	Etableringsbegäran för anslutningsresursen för den privata länktjänsten 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 Private Link-tjänstanslutning till den privata Azure-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
enabled

SearchEncryptionComplianceStatus

Uppräkning

Beskriver om söktjänsten är kompatibel eller inte när det gäller att ha icke-kundkrypterade resurser. Om en tjänst har mer än en icke-kundkrypterad resurs och "Enforcement" är "aktiverad" markeras tjänsten som "icke-kompatibel".

Värde	Description
Compliant	Anger att söktjänsten är kompatibel, antingen på grund av att antalet icke-kundkrypterade resurser är noll eller att tvingande är inaktiverat.
NonCompliant	Anger att söktjänsten har mer än en icke-kundkrypterad resurs.

SearchEncryptionWithCmk

Uppräkning

Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.

Värde	Description
Disabled	Ingen tillämpning görs och söktjänsten kan ha icke-kundkrypterade resurser.
Enabled	Söktjänsten markeras som icke-kompatibel om det finns en eller flera icke-kundkrypterade resurser.
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 sök-SKU:er på vissa platser.

Värde	Description
disabled	Anger att semantisk rangordning är inaktiverad för söktjänsten.
free	Aktiverar semantisk rangordning för en söktjänst och anger att den ska användas inom gränserna för den kostnadsfria nivån. Detta 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 rangordning på en söktjänst som en fakturerbar funktion, med högre dataflöde och volym av semantiska rangordningsbegäranden.

SearchService

Objekt

Beskriver en söktjänst 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 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.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.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 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 söktjä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 söktjä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 sök-SKU:er på vissa platser.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Listan över resurser för delad privat länk som hanteras av söktjä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. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel undersöker Microsoft aktivt 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 faktureringshastighet och kapacitetsbegränsningar. 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"

SearchServiceListResult

Objekt

Svar som innehåller en lista över söktjänster.

Name	Typ	Description
nextLink	string	Begär URL som kan användas för att fråga nästa sida i söktjänsterna. Returneras när det totala antalet begärda söktjänster överskrider den maximala sidstorleken.
value	SearchService[]	Listan över söktjänster.

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. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel undersöker Microsoft aktivt 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.

SharedPrivateLinkResource

Objekt

Beskriver en resurs för delad privat länk som hanteras av söktjänsten.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en resurs för delad privat länk som hanteras av söktjänsten.
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 söktjänsten.

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 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	Begärandemeddelandet 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 ska skapas till. 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 delad privat länk. 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
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

Uppräkning

Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Värde	Description
Approved
Disconnected
Pending
Rejected

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.