Services - Get

Reference

Service:: Search Management

API Version:: 2024-03-01-preview

Gets the search service with the given name in the given resource group.

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

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.
searchServiceName	path	True	string	The name of the Azure AI Search service associated with the specified resource group. Regex pattern: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API 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	SearchService	The search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.
Other Status Codes	CloudError	HTTP 404 (Not Found): The subscription, resource group, or search service name could not be found.

Security

azure_auth

Specifies an implicit grant flow, as supported on the Microsoft Identity platform.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SearchGetService

Sample request

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

Sample response

Status code:: 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": []
  }
}

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	Details about the search service identity. A null value indicates that the search service has no identity assigned.
IdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
IpRule	The IP restriction rule of the Azure AI Search service.
NetworkRuleSet	Network specific rules that determine how the Azure AI Search service may be reached.
PrivateEndpoint	The private endpoint resource from Microsoft.Network provider.
PrivateEndpointConnection	Describes an existing private endpoint connection to the Azure AI 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, Incomplete, or Canceled.
PrivateLinkServiceConnectionState	Describes the current state of an existing Azure Private Link service connection to the 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.
SearchBypass	Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
SearchDisabledDataExfiltrationOption	A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
SearchEncryptionComplianceStatus	Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
SearchEncryptionWithCmk	Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
SearchSemanticSearch	Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
SearchService	Describes an Azure AI Search service and its current state.
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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team 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 Azure AI Search service.
SharedPrivateLinkResourceProperties	Describes the properties of an existing shared private link resource managed by the Azure AI 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.'
UserAssignedManagedIdentity	The details of the user assigned managed identity assigned to the search service.

AadAuthFailureMode

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

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

ApiKeyOnly

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

CloudError

Contains information about an API error.

Name	Type	Description
error	CloudErrorBody	Describes a particular API error with an error code and a message.
message	string	A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property).

CloudErrorBody

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

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

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

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

Name	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
enforcement	SearchEncryptionWithCmk	Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.

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

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

Identity

Details about the search service identity. A null value indicates that the search service has no identity assigned.

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 type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
userAssignedIdentities	<string, UserAssignedManagedIdentity>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.

Name	Type	Description
None	string	Indicates that any identity associated with the search service needs to be removed.
SystemAssigned	string	Indicates that system-assigned identity for the search service will be enabled.
SystemAssigned, UserAssigned	string	Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities.
UserAssigned	string	Indicates that one or more user assigned identities will be assigned to the search service.

IpRule

The IP restriction rule of the Azure AI Search service.

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

NetworkRuleSet

Network specific rules that determine how the Azure AI Search service may be reached.

Name	Type	Description
bypass	SearchBypass	Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
ipRules	IpRule[]	A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.

PrivateEndpoint

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

Describes an existing private endpoint connection to the Azure AI 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 Azure AI Search service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Describes the properties of an existing private endpoint connection to the search service.

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

PrivateLinkServiceConnectionProvisioningState

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

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

PrivateLinkServiceConnectionState

Describes the current state of an existing Azure Private Link service connection to the 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

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

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

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.

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

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.

Name	Type	Description
disabled	string	The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
enabled	string	The search service is accessible from traffic originating from the public internet.

SearchBypass

Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.

Name	Type	Description
AzurePortal	string	Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section.
None	string	Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default.

SearchDisabledDataExfiltrationOption

A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.

Name	Type	Description
All	string	Indicates that all data exfiltration scenarios are disabled.

SearchEncryptionComplianceStatus

Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.

Name	Type	Description
Compliant	string	Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled.
NonCompliant	string	Indicates that the search service has more than one non-CMK-encrypted objects.

SearchEncryptionWithCmk

Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.

Name	Type	Description
Disabled	string	No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used.
Enabled	string	Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key.
Unspecified	string	Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'.

SearchSemanticSearch

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

Name	Type	Description
disabled	string	Indicates that semantic reranker is disabled for the search service. This is the default.
free	string	Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan 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	string	Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.

SearchService

Describes an Azure AI 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.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
properties.eTag	string		A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
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 Azure AI 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 Azure AI 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 Azure AI Search SKUs in certain locations.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		The list of shared private link resources managed by the Azure AI 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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team 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 price tier 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"

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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.

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

SharedPrivateLinkResource

Describes a shared private link resource managed by the Azure AI 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 Azure AI Search service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Describes the properties of an existing shared private link resource managed by the Azure AI 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 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 for which a shared private link is being 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

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

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

SharedPrivateLinkResourceStatus

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

Name	Type	Description
Approved	string	The shared private link resource is approved and is ready for use.
Disconnected	string	The shared private link resource has been removed from the service.
Pending	string	The shared private link resource has been created and is pending approval.
Rejected	string	The shared private link resource has been rejected and cannot be used.

Sku

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

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

Name	Type	Description
basic	string	Billable tier for a dedicated service having up to 3 replicas.
free	string	Free tier, with no SLA guarantees and a subset of the features offered on billable tiers.
standard	string	Billable tier for a dedicated service having up to 12 partitions and 12 replicas.
standard2	string	Similar to 'standard', but with more capacity per search unit.
standard3	string	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	string	Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
storage_optimized_l2	string	Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.

UserAssignedManagedIdentity

The details of the user assigned managed identity assigned to the search service.

Name	Type	Description
clientId	string	The client ID of user assigned identity.
principalId	string	The principal ID of user assigned identity.

Share via

Services - Get

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Examples

SearchGetService

Sample request

Sample response

Definitions

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

Additional resources