Microsoft.Search (preview:2025-02-01)

2025/01/16 • 29 new methods

Operations_List (new)
Description :  Lists all of the available REST API operations of the Microsoft.Search provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Search/operations
{
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. This name is of the form {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: The friendly name of the resource provider. ,
Required: False ,
}
string ,
operation:
{
Description: The operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
resource:
{
Description: The resource type on which the operation is performed. ,
Required: False ,
}
string ,
description:
{
Description: The friendly name of the operation. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider. ,
Required: False ,
}
boolean ,
origin:
{
Description: Describes which originating entities are allowed to invoke this operation. ,
Required: False ,
}
string ,
properties:
{
Description: Describes additional properties for this operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Specifications of the service for this operation. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Specifications of metrics for this operation. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric specification. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the metric specification. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The display description of the metric specification. ,
Required: False ,
}
string ,
unit:
{
Description: The unit for the metric specification. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The type of aggregation for the metric specification. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions for the metric specification. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the dimension. ,
Required: False ,
}
string ,
}
,
]
,
availabilities:
{
Description: Availabilities for the metric specification. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain for the dimension. ,
Required: False ,
}
string ,
blobDuration:
{
Description: The blob duration for the dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Specifications of logs for this operation. ,
Required: False ,
}
[
{
name:
{
Description: The name of the log specification. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the log specification. ,
Required: False ,
}
string ,
blobDuration:
{
Description: The blob duration for the log specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of operation list results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Offerings_List (new)
Description :  Lists all of the features and SKUs offered by the Azure AI Search service in each region.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Search/offerings
{
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of regions with their respective features and SKUs offered. ,
Required: False ,
}
[
{
regionName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
features:
{
Description: The list of features offered in this region. ,
Required: False ,
}
[
{
name:
{
Description: The name of the feature offered in this region. ,
Enum:
{
Grok: Supports Grok feature. ,
ImageVectorization: Supports Image Vectorization feature. ,
DocumentIntelligence: Supports Document Intelligence feature. ,
QueryRewrite: Supports Query Rewrite feature. ,
S3: Supports S3 feature. ,
StorageOptimized: Supports Storage Optimized feature. ,
SemanticSearch: Supports Semantic Search feature. ,
MegaStore: Supports Mega Store feature. ,
AvailabilityZones: Supports Availability Zones feature. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
skus:
{
Description: The list of SKUs offered in this region. ,
Required: False ,
}
[
{
sku:
{
Description: Defines the SKU of a search service, which determines billing rate and capacity limits. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
limits:
{
Description: The limits associated with this SKU offered in this region. ,
Required: False ,
}
{
indexes:
{
Description: The maximum number of indexes available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
indexers:
{
Description: The maximum number of indexers available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionStorageInGigabytes:
{
Description: The maximum storage size in Gigabytes available for this SKU per partition. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionVectorStorageInGigabytes:
{
Description: The maximum vector storage size in Gigabytes available for this SKU per partition. ,
Format: int32 ,
Required: False ,
}
integer ,
searchUnits:
{
Description: The maximum number of search units available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
replicas:
{
Description: The maximum number of replicas available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
partitions:
{
Description: The maximum number of partitions available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of offerings, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
AdminKeys_Get (new)
Description :  Gets the primary and secondary admin API keys for the specified Azure AI Search service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary admin API key of the search service. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary admin API key of the search service. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
AdminKeys_Regenerate (new)
Description :  Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
keyKind:
{
Description: Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary admin API key of the search service. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary admin API key of the search service. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
QueryKeys_Create (new)
Description :  Generates a new query key for the specified search service. You can create up to 50 query keys per service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the new query API key. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used. ,
Required: False ,
}
string ,
key:
{
Description: The value of the query API key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
QueryKeys_ListBySearchService (new)
Description :  Returns the list of query API keys for the given Azure AI Search service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The query keys for the Azure AI Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used. ,
Required: False ,
}
string ,
key:
{
Description: The value of the query API key. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
QueryKeys_Delete (new)
Description :  Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
key:
{
Description: The query key to be deleted. Query keys are identified by value, not by name. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_CreateOrUpdate (new)
Description :  Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created. ,
Required: True ,
}
string ,
service:
{
Description: The definition of the search service to create or update. ,
Required: True ,
}
{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_Update (new)
Description :  Updates an existing search service in the given resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service to update. ,
Required: True ,
}
string ,
service:
{
Description: The definition of the search service to update. ,
Required: True ,
}
{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geographic location of the resource. This must be one of the supported and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags to help categorize the resource in the Azure portal. ,
Required: False ,
}
object ,
identity:
{
Description: Details about the search service identity. A null value indicates that the search service has no identity assigned. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_Get (new)
Description :  Gets the search service with the given name in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_Delete (new)
Description :  Deletes a search service in the given resource group, along with its associated resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_ListByResourceGroup (new)
Description :  Gets a list of all Search services in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of search services. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
PrivateLinkResources_ListSupported (new)
Description :  Gets a list of all supported private link resource types for the given service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources
{
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of supported Private Link Resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a supported private link resource for the Azure AI Search service. ,
Required: False ,
}
{
groupId:
{
Description: The group ID of the private link resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The list of required members of the private link resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The list of required DNS zone names of the private link resource. ,
Required: False ,
}
[
string ,
]
,
shareablePrivateLinkResourceTypes:
{
Description: The list of resources that are onboarded to private link service, that are supported by Azure AI Search. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource type that has been onboarded to private link service, supported by Azure AI Search. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. ,
Required: False ,
}
{
type:
{
Description: The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search. ,
Required: False ,
}
string ,
groupId:
{
Description: The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search. ,
Required: False ,
}
string ,
description:
{
Description: The description of the resource type that has been onboarded to private link service, supported by Azure AI Search. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Update (new)
Description :  Updates a private endpoint connection to the search service in the given resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure AI Search service with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The definition of the private endpoint connection to update. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the details of the private endpoint connection to the search service in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure AI Search service with the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (new)
Description :  Disconnects the private endpoint connection and deletes it from the search service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure AI Search service with the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByService (new)
Description :  Gets a list of all private endpoint connections in the given service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections
{
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
SharedPrivateLinkResources_CreateOrUpdate (new)
Description :  Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. ,
Required: True ,
}
string ,
sharedPrivateLinkResource:
{
Description: The definition of the shared private link resource to create or update. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
SharedPrivateLinkResources_Get (new)
Description :  Gets the details of the shared private link resource managed by the search service in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
SharedPrivateLinkResources_Delete (new)
Description :  Initiates the deletion of the shared private link resource from the search service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
SharedPrivateLinkResources_ListByService (new)
Description :  Gets a list of all shared private link resources managed by the given service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources
{
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of shared private link resources, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_ListBySubscription (new)
Description :  Gets a list of all Search services in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices
{
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of search services. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Services_CheckNameAvailability (new)
Description :  Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability
{
checkNameAvailabilityInput:
{
Description: The resource name and type to check. ,
Required: True ,
}
{
name:
{
Description: The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. This value must always be 'searchServices'. ,
Enum:
{
searchServices: 'searchServices' is the only resource type whose name can be validated. ,
}
,
Required: True ,
}
enum ,
}
,
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: A value indicating whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: The search service name doesn't match naming requirements. ,
AlreadyExists: The search service name is already assigned to a different search service. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Usages_ListBySubscription (new)
Description :  Get a list of all Azure AI Search quota usages across the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages
{
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: The unique location name for a Microsoft Azure geographic region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The quota usages for the SKUs supported by Azure AI Search. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of measurement for the search SKU. ,
Required: False ,
}
string ,
currentValue:
{
Description: The currently used up value for the particular search SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The quota limit for the particular search SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU supported by Azure AI Search. ,
Required: False ,
}
{
value:
{
Description: The SKU name supported by Azure AI Search. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized string value for the SKU name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
UsageBySubscriptionSku (new)
Description :  Gets the quota usage for a search SKU in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}
{
x-ms-client-request-id:
{
Description: 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. ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: The unique location name for a Microsoft Azure geographic region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
skuName:
{
Description: The unique SKU name that identifies a billable tier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of measurement for the search SKU. ,
Required: False ,
}
string ,
currentValue:
{
Description: The currently used up value for the particular search SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The quota limit for the particular search SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU supported by Azure AI Search. ,
Required: False ,
}
{
value:
{
Description: The SKU name supported by Azure AI Search. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized string value for the SKU name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
NetworkSecurityPerimeterConfigurations_ListByService (new)
Description :  Gets a list of network security perimeter configurations for a search service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
networkSecurityPerimeter:
{
Description: The perimeter for a network security perimeter configuration. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: The resource association for the network security perimeter. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessMode:
{
Required: False ,
}
string ,
}
,
profile:
{
Description: The profile for a network security perimeter configuration. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessRulesVersion:
{
Required: False ,
}
string ,
accessRules:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Description: The properties for the access rules in a network security perimeter configuration. ,
Required: False ,
}
{
direction:
{
Required: False ,
}
string ,
addressPrefixes:
{
Required: False ,
}
[
string ,
]
,
fullyQualifiedDomainNames:
{
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Required: False ,
}
[
string ,
]
,
networkSecurityPerimeters:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningIssues:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Description: The properties to describe any issues with provisioning network security perimeters to a search service. ,
Required: False ,
}
{
issueType:
{
Required: False ,
}
string ,
severity:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
suggestedResourceIds:
{
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
NetworkSecurityPerimeterConfigurations_Get (new)
Description :  Gets a network security perimeter configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
nspConfigName:
{
Description: The network security configuration name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
networkSecurityPerimeter:
{
Description: The perimeter for a network security perimeter configuration. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: The resource association for the network security perimeter. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessMode:
{
Required: False ,
}
string ,
}
,
profile:
{
Description: The profile for a network security perimeter configuration. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessRulesVersion:
{
Required: False ,
}
string ,
accessRules:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Description: The properties for the access rules in a network security perimeter configuration. ,
Required: False ,
}
{
direction:
{
Required: False ,
}
string ,
addressPrefixes:
{
Required: False ,
}
[
string ,
]
,
fullyQualifiedDomainNames:
{
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Required: False ,
}
[
string ,
]
,
networkSecurityPerimeters:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningIssues:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Description: The properties to describe any issues with provisioning network security perimeters to a search service. ,
Required: False ,
}
{
issueType:
{
Required: False ,
}
string ,
severity:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
suggestedResourceIds:
{
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description :  Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter configurations by ensuring the search service carries the latest configuration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}/reconcile
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
nspConfigName:
{
Description: The network security configuration name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}
Service_Upgrade (new)
Description :  Upgrades the Azure AI Search service to the latest version available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/upgrade
{
resourceGroupName:
{
Description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
searchServiceName:
{
Description: The name of the Azure AI Search service associated with the specified resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the search service. ,
Required: False ,
}
{
replicaCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
endpoint:
{
Description: The endpoint of the Azure AI Search service. ,
Format: uri ,
Required: False ,
}
string ,
hostingMode:
{
Description: 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'. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
computeType:
{
Description: Configure this property to support the search service using either the default compute or Azure Confidential Compute. ,
Enum:
{
default: Create the service with the default compute. ,
confidential: Create the service with Azure Confidential Compute. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: 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. ,
Enum:
{
enabled: The search service is accessible from traffic originating from the public internet. ,
disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: 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. ,
Enum:
{
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 because underlying search units are not healthy. ,
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. ,
stopped: The search service is in a subscription that's disabled. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The details of the search service status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. ,
Enum:
{
Succeeded: The last provisioning operation has completed successfully. ,
Provisioning: The search service is being provisioned or scaled up or down. ,
Failed: The last provisioning operation has failed. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure AI Search service may be reached. ,
Required: False ,
}
{
ipRules:
{
Description: 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. ,
Required: False ,
}
[
{
value:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
bypass:
{
Description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. ,
Enum:
{
None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. ,
AzurePortal: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. ,
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. ,
}
,
Required: False ,
}
enum ,
}
,
disabledDataExfiltrationOptions:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
encryptionWithCmk:
{
Description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. ,
Required: False ,
}
{
enforcement:
{
Description: Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. ,
Enum:
{
Disabled: No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used. ,
Enabled: Search service will be marked as non-compliant if one or more objects aren't encrypted with a customer-managed key. ,
Unspecified: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. ,
}
,
Required: False ,
}
enum ,
encryptionComplianceStatus:
{
Description: 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. ,
Enum:
{
Compliant: Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled. ,
NonCompliant: Indicates that the search service has more than one non-CMK-encrypted objects. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: 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. ,
Required: False ,
}
boolean ,
authOptions:
{
Description: 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. ,
Required: False ,
}
{
apiKeyOnly:
{
Description: Indicates that only the API key can be used for authentication. ,
Required: False ,
}
object ,
aadOrApiKey:
{
Description: Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. ,
Required: False ,
}
{
aadAuthFailureMode:
{
Description: Describes what response the data plane API of a search service would send for requests that failed authentication. ,
Enum:
{
http403: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). ,
http401WithBearerChallenge: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
semanticSearch:
{
Description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. ,
Enum:
{
disabled: Indicates that semantic reranker is disabled for the search service. This is the default. ,
free: 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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing private endpoint connection to the Azure AI Search service. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint resource from Microsoft.Network provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Describes the current state of an existing Azure Private Link service connection to the private endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: The private endpoint connection has been created and is pending approval. ,
Approved: The private endpoint connection is approved and is ready for use. ,
Rejected: The private endpoint connection has been rejected and cannot be used. ,
Disconnected: The private endpoint connection has been removed from the service. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for the private link service connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A description of any extra actions that may be required. ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: The group ID of the Azure resource for which the private link service is for. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. ,
Enum:
{
Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. ,
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. ,
Succeeded: The private link service connection has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. ,
Canceled: Provisioning request for the private link service connection resource has been canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources managed by the Azure AI Search service. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a shared private link resource managed by the Azure AI Search service. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
resourceRegion:
{
Description: 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). ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link resource has been created and is pending approval. ,
Approved: The shared private link resource is approved and is ready for use. ,
Rejected: The shared private link resource has been rejected and cannot be used. ,
Disconnected: The shared private link resource has been removed from the service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. ,
Enum:
{
Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional. ,
Deleting: The shared private link resource is in the process of being deleted. ,
Failed: The shared private link resource has failed to be provisioned or deleted. ,
Succeeded: The shared private link resource has finished provisioning and is ready for approval. ,
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
eTag:
{
Description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. ,
Required: False ,
}
string ,
upgradeAvailable:
{
Description: Indicates whether or not the search service has an upgrade available. ,
Required: False ,
}
boolean ,
serviceUpgradeDate:
{
Description: The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. ,
Required: False ,
}
{
name:
{
Description: 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.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
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. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system-assigned identity of the search service. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
None: Indicates that any identity associated with the search service needs to be removed. ,
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled. ,
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service. ,
SystemAssigned, UserAssigned: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}