Services - List By Resource Group

Service:

Search Management

API Version:

2023-11-01

Gets a list of all Search services in the given resource group.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API, command line tools, or the portal.
api-version	query	True	string	The API version to use for each request.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Responses

Name	Type	Description
200 OK	SearchServiceListResult	The operation succeeded. The response contains the list of all search service definitions for the given resource group.
Other Status Codes	CloudError	An unexpected error occurred during the operation.

Security

azure_auth

Microsoft Entra ID OAuth2 authorization flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SearchListServicesByResourceGroup

Sample request

HTTP

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

Java

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

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_list_services_by_resource_group.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_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.json
if __name__ == "__main__":
    main()

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

Go

package armsearch_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.json
func ExampleServicesClient_NewListByResourceGroupPager() {
	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().NewListByResourceGroupPager("rg1", &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/rg1/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

JavaScript

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

dotnet

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

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.json
// this example is just showing the usage of "Services_ListByResourceGroup" 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 and iterate over the result
await foreach (SearchServiceResource item in collection.GetAllAsync())
{
    // 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

Sample response

Status code:

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/rg1/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": []
      }
    }
  ]
}

Definitions

Name	Description
AadAuthFailureMode	Describes what response the data plane API of a search service would send for requests that failed authentication.
ApiKeyOnly	Indicates that only the API key can be used for authentication.
CloudError	Contains information about an API error.
CloudErrorBody	Describes a particular API error with an error code and a message.
DataPlaneAadOrApiKeyAuthOption	Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
DataPlaneAuthOptions	Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.
EncryptionWithCmk	Describes a policy that determines how resources within the search service are to be encrypted with customer=managed keys.
HostingMode	Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
Identity	Identity for the resource.
IdentityType	The identity type.
IpRule	The IP restriction rule of the search service.
NetworkRuleSet	Network-specific rules that determine how the search service can be reached.
PrivateEndpoint	The private endpoint resource from Microsoft.Network provider.
PrivateEndpointConnection	Describes an existing private endpoint connection to the search service.
PrivateEndpointConnectionProperties	Describes the properties of an existing Private Endpoint connection to the search service.
PrivateLinkServiceConnectionProvisioningState	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete
PrivateLinkServiceConnectionState	Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
PrivateLinkServiceConnectionStatus	Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
ProvisioningState	The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
PublicNetworkAccess	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
SearchEncryptionComplianceStatus	Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
SearchEncryptionWithCmk	Describes how a search service should enforce having one or more non-customer-encrypted resources.
SearchSemanticSearch	Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
SearchService	Describes a search service and its current state.
SearchServiceListResult	Response containing a list of search services.
SearchServiceStatus	The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
SharedPrivateLinkResource	Describes a Shared Private Link Resource managed by the search service.
SharedPrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource managed by the search service.
SharedPrivateLinkResourceProvisioningState	The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
SharedPrivateLinkResourceStatus	Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
Sku	Defines the SKU of a search service, which determines billing rate and capacity limits.
SkuName	The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'

AadAuthFailureMode

Enumeration

Describes what response the data plane API of a search service would send for requests that failed authentication.

Value	Description
http401WithBearerChallenge	Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.
http403	Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).

ApiKeyOnly

Object

Indicates that only the API key can be used for authentication.

CloudError

Object

Contains information about an API error.

Name	Type	Description
error	CloudErrorBody	Describes a particular API error with an error code and a message.

CloudErrorBody

Object

Describes a particular API error with an error code and a message.

Name	Type	Description
code	string	An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.
details	CloudErrorBody[]	Contains nested errors that are related to this error.
message	string	A message that describes the error in detail and provides debugging information.
target	string	The target of the particular error (for example, the name of the property in error).

DataPlaneAadOrApiKeyAuthOption

Object

Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.

Name	Type	Description
aadAuthFailureMode	AadAuthFailureMode	Describes what response the data plane API of a search service would send for requests that failed authentication.

DataPlaneAuthOptions

Object

Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.

Name	Type	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
apiKeyOnly	ApiKeyOnly	Indicates that only the API key can be used for authentication.

EncryptionWithCmk

Object

Describes a policy that determines how resources within the search service are to be encrypted with customer=managed keys.

Name	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
enforcement	SearchEncryptionWithCmk	Describes how a search service should enforce having one or more non-customer-encrypted resources.

HostingMode

Enumeration

Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.

Value	Description
default	The limit on number of indexes is determined by the default limits for the SKU.
highDensity	Only application for standard3 SKU, where the search service can have up to 1000 indexes.

Identity

Object

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of the system-assigned identity of the search service.
tenantId	string	The tenant ID of the system-assigned identity of the search service.
type	IdentityType	The identity type.

IdentityType

Enumeration

The identity type.

Value	Description
None
SystemAssigned

IpRule

Object

The IP restriction rule of the search service.

Name	Type	Description
value	string	Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP range in CIDR format (for example, 123.1.2.3/24) to be allowed.

NetworkRuleSet

Object

Network-specific rules that determine how the search service can be reached.

Name	Type	Description
ipRules	IpRule[]	A list of IP restriction rules used for an IP firewall. Any IPs that do not match the rules are blocked by the firewall. These rules are only applied when the 'publicNetworkAccess' of the search service is 'enabled'.

PrivateEndpoint

Object

The private endpoint resource from Microsoft.Network provider.

Name	Type	Description
id	string	The resource id of the private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnection

Object

Describes an existing private endpoint connection to the search service.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	Describes the properties of an existing private endpoint connection to the search service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

Describes the properties of an existing Private Endpoint connection to the search service.

Name	Type	Description
groupId	string	The group id from the provider of resource the private link service connection is for.
privateEndpoint	PrivateEndpoint	The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
provisioningState	PrivateLinkServiceConnectionProvisioningState	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete

PrivateLinkServiceConnectionProvisioningState

Enumeration

The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete

Value	Description
Canceled	Provisioning request for the private link service connection resource has been canceled
Deleting	The private link service connection is in the process of being deleted.
Failed	The private link service connection has failed to be provisioned or deleted.
Incomplete	Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet.
Succeeded	The private link service connection has finished provisioning and is ready for approval.
Updating	The private link service connection is in the process of being created along with other resources for it to be fully functional.

PrivateLinkServiceConnectionState

Object

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

Name	Type	Default value	Description
actionsRequired	string	None	A description of any extra actions that may be required.
description	string		The description for the private link service connection state.
status	PrivateLinkServiceConnectionStatus		Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

PrivateLinkServiceConnectionStatus

Enumeration

Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

Value	Description
Approved	The private endpoint connection is approved and is ready for use.
Disconnected	The private endpoint connection has been removed from the service.
Pending	The private endpoint connection has been created and is pending approval.
Rejected	The private endpoint connection has been rejected and cannot be used.

ProvisioningState

Enumeration

The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.

Value	Description
failed	The last provisioning operation has failed.
provisioning	The search service is being provisioned or scaled up or down.
succeeded	The last provisioning operation has completed successfully.

PublicNetworkAccess

Enumeration

This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.

Value	Description
disabled
enabled

SearchEncryptionComplianceStatus

Enumeration

Describes whether the search service is compliant or not with respect to having non-customer-encrypted resources. If a service has more than one non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.

Value	Description
Compliant	Indicates that the search service is compliant, either because number of non-customer-encrypted resources is zero or enforcement is disabled.
NonCompliant	Indicates that the search service has more than one non-customer-encrypted resources.

SearchEncryptionWithCmk

Enumeration

Describes how a search service should enforce having one or more non-customer-encrypted resources.

Value	Description
Disabled	No enforcement will be made and the search service can have non-customer-encrypted resources.
Enabled	Search service will be marked as non-compliant if there are one or more non-customer-encrypted resources.
Unspecified	Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.

SearchSemanticSearch

Enumeration

Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.

Value	Description
disabled	Indicates that semantic ranking is disabled for the search service.
free	Enables semantic ranking on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.
standard	Enables semantic ranking on a search service as a billable feature, with higher throughput and volume of semantic ranking requests.

SearchService

Object

Describes a search service and its current state.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /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		Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
properties.disableLocalAuth	boolean		When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
properties.encryptionWithCmk	EncryptionWithCmk		Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
properties.hostingMode	HostingMode	default	Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
properties.networkRuleSet	NetworkRuleSet		Network-specific rules that determine how the search service may be reached.
properties.partitionCount	integer	1	The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		The list of private endpoint connections to the search service.
properties.provisioningState	ProvisioningState		The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
properties.replicaCount	integer	1	The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
properties.semanticSearch	SearchSemanticSearch		Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		The list of shared private link resources managed by the search service.
properties.status	SearchServiceStatus		The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
properties.statusDetails	string		The details of the search service status.
sku	Sku		The SKU of the search service, which determines billing rate and capacity limits. This property is required when creating a new search service.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SearchServiceListResult

Object

Response containing a list of search services.

Name	Type	Description
nextLink	string	Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size.
value	SearchService[]	The list of search services.

SearchServiceStatus

Enumeration

The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, Microsoft is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.

Value	Description
degraded	The search service is degraded because underlying search units are not healthy.
deleting	The search service is being deleted.
disabled	The search service is disabled and all API requests will be rejected.
error	The search service is in error state, indicating either a failure to provision or to be deleted.
provisioning	The search service is being provisioned or scaled up or down.
running	The search service is running and no provisioning operations are underway.

SharedPrivateLinkResource

Object

Describes a Shared Private Link Resource managed by the search service.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	SharedPrivateLinkResourceProperties	Describes the properties of a Shared Private Link Resource managed by the search service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Object

Describes the properties of an existing Shared Private Link Resource managed by the search service.

Name	Type	Description
groupId	string	The group id from the provider of resource the shared private link resource is for.
privateLinkResourceId	string	The resource id of the resource the shared private link resource is for.
provisioningState	SharedPrivateLinkResourceProvisioningState	The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
requestMessage	string	The request message for requesting approval of the shared private link resource.
resourceRegion	string	Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

SharedPrivateLinkResourceProvisioningState

Enumeration

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

Value	Description
Deleting
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

Enumeration

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

Value	Description
Approved
Disconnected
Pending
Rejected

Sku

Object

Defines the SKU of a search service, which determines billing rate and capacity limits.

Name	Type	Description
name	SkuName	The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'

SkuName

Enumeration

The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'

Value	Description
basic	Billable tier for a dedicated service having up to 3 replicas.
free	Free tier, with no SLA guarantees and a subset of the features offered on billable tiers.
standard	Billable tier for a dedicated service having up to 12 partitions and 12 replicas.
standard2	Similar to 'standard', but with more capacity per search unit.
standard3	The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity').
storage_optimized_l1	Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
storage_optimized_l2	Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.