Microsoft.Search (stable:2020-03-13)

2025/12/05 • 18 new, 18 deleted 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 supported by the resource provider. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of operation list results, if any. ,
Required: False ,
}
string ,
}
AdminKeys_Get (new)
Description :  Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Cognitive 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 ,
]
,
}
,
}
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 Cognitive 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 ,
]
,
}
,
}
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 Cognitive 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; may be empty. ,
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 ,
]
,
}
,
}
QueryKeys_ListBySearchService (new)
Description :  Returns the list of query API keys for the given Azure Cognitive 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 Cognitive 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 Cognitive Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the query API key; may be empty. ,
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 ,
]
,
}
,
}
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 Cognitive 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 ,
]
,
}
,
}
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 Cognitive 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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: 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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 ,
]
,
}
,
}
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 Cognitive 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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: 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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 ,
]
,
}
,
}
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 Cognitive 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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 ,
]
,
}
,
}
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 Cognitive 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 ,
]
,
}
,
}
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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
]
,
}
,
}
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of supported Private Link Resources. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a supported private link resource for the Azure Cognitive 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 ,
]
,
}
,
}
,
]
,
}

⚐ 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 ,
]
,
}
,
}
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The definition of the private endpoint connection to update. ,
Required: True ,
}
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
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)

{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure Cognitive 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)

{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure Cognitive 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)

{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Private Endpoint connections. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
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 ,
]
,
}
,
}
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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
]
,
}
,
}
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: No description available. ,
}
,
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: No description available. ,
AlreadyExists: No description available. ,
}
,
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 ,
]
,
}
,
}
Operations_List (removed)
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 supported by the resource provider. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of operation list results, if any. ,
Required: False ,
}
string ,
}
AdminKeys_Get (removed)
Description :  Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Cognitive 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 ,
]
,
}
,
}
AdminKeys_Regenerate (removed)
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 Cognitive 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 ,
]
,
}
,
}
QueryKeys_Create (removed)
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 Cognitive 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; may be empty. ,
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 ,
]
,
}
,
}
QueryKeys_ListBySearchService (removed)
Description :  Returns the list of query API keys for the given Azure Cognitive 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 Cognitive 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 Cognitive Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the query API key; may be empty. ,
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 ,
]
,
}
,
}
QueryKeys_Delete (removed)
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 Cognitive 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 ,
]
,
}
,
}
Services_CreateOrUpdate (removed)
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 Cognitive 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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: 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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 ,
]
,
}
,
}
Services_Update (removed)
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 Cognitive 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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: 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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 ,
]
,
}
,
}
Services_Get (removed)
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 Cognitive 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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
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 ,
]
,
}
,
}
Services_Delete (removed)
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 Cognitive 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 ,
]
,
}
,
}
Services_ListByResourceGroup (removed)
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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
]
,
}
,
}
PrivateLinkResources_ListSupported (removed)
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of supported Private Link Resources. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a supported private link resource for the Azure Cognitive 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 ,
]
,
}
,
}
,
]
,
}

⚐ 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 ,
]
,
}
,
}
PrivateEndpointConnections_Update (removed)
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The definition of the private endpoint connection to update. ,
Required: True ,
}
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
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)

{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure Cognitive 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)

{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection to the Azure Cognitive 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)

{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}
PrivateEndpointConnections_ListByService (removed)
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 Cognitive Search service associated with the specified resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Private Endpoint connections. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
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 ,
]
,
}
,
}
Services_ListBySubscription (removed)
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 ,
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: No description available. ,
highDensity: No description available. ,
}
,
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: No description available. ,
disabled: No description available. ,
}
,
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive 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: No description available. ,
provisioning: No description available. ,
deleting: No description available. ,
degraded: No description available. ,
disabled: No description available. ,
error: No description available. ,
}
,
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: No description available. ,
provisioning: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleSet:
{
Description: Network specific rules that determine how the Azure Cognitive 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 ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections to the Azure Cognitive Search service. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Private Link Service connection to the Azure Private Endpoint. ,
Required: False ,
}
{
status:
{
Description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
}
,
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: No description available. ,
basic: No description available. ,
standard: No description available. ,
standard2: No description available. ,
standard3: No description available. ,
storage_optimized_l1: No description available. ,
storage_optimized_l2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
]
,
}
,
}
Services_CheckNameAvailability (removed)
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: No description available. ,
}
,
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: No description available. ,
AlreadyExists: No description available. ,
}
,
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 ,
]
,
}
,
}