diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2020-08-01-preview/search.json b/specification/search/resource-manager/Microsoft.Search/preview/2020-08-01-preview/search.json index 274c05d42d8b..5e6a16736b32 100644 --- a/specification/search/resource-manager/Microsoft.Search/preview/2020-08-01-preview/search.json +++ b/specification/search/resource-manager/Microsoft.Search/preview/2020-08-01-preview/search.json @@ -93,13 +93,13 @@ ], "responses": { "200": { - "description": "The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your Search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.", + "description": "The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.", "schema": { "$ref": "#/definitions/AdminKeyResult" } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -162,7 +162,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -181,7 +181,7 @@ "$ref": "./examples/SearchCreateQueryKey.json" } }, - "description": "Generates a new query key for the specified Search service. You can create up to 50 query keys per service.", + "description": "Generates a new query key for the specified search service. You can create up to 50 query keys per service.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -217,7 +217,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -262,13 +262,13 @@ ], "responses": { "200": { - "description": "All query keys for the given Search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.", + "description": "All query keys for the given search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.", "schema": { "$ref": "#/definitions/ListQueryKeysResult" } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -323,7 +323,7 @@ "description": "The query key was successfully deleted." }, "404": { - "description": "The subscription, resource group, Search service, or query key could not be found." + "description": "The subscription, resource group, search service, or query key could not be found." }, "default": { "description": "HTTP 409 (Conflict): The specified subscription is disabled.", @@ -354,7 +354,7 @@ "$ref": "./examples/SearchCreateOrUpdateServiceWithIdentity.json" } }, - "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.", + "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.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -376,7 +376,7 @@ "schema": { "$ref": "#/definitions/SearchService" }, - "description": "The definition of the Search service to create or update." + "description": "The definition of the search service to create or update." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -396,7 +396,7 @@ } }, "201": { - "description": "If you requested creation of a free Search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", + "description": "If you requested creation of a free search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", "schema": { "$ref": "#/definitions/SearchService" } @@ -429,7 +429,7 @@ "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json" } }, - "description": "Updates an existing Search service in the given resource group.", + "description": "Updates an existing search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -451,7 +451,7 @@ "schema": { "$ref": "#/definitions/SearchServiceUpdate" }, - "description": "The definition of the Search service to update." + "description": "The definition of the search service to update." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -488,7 +488,7 @@ "$ref": "./examples/SearchGetService.json" } }, - "description": "Gets the Search service with the given name in the given resource group.", + "description": "Gets the search service with the given name in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -511,13 +511,13 @@ ], "responses": { "200": { - "description": "The Search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", + "description": "The search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", "schema": { "$ref": "#/definitions/SearchService" } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service name could not be found.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service name could not be found.", "schema": { "$ref": "#/definitions/CloudError" } @@ -534,7 +534,7 @@ "$ref": "./examples/SearchDeleteService.json" } }, - "description": "Deletes a Search service in the given resource group, along with its associated resources.", + "description": "Deletes a search service in the given resource group, along with its associated resources.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -557,13 +557,13 @@ ], "responses": { "200": { - "description": "The Search service was successfully deleted." + "description": "The search service was successfully deleted." }, "204": { - "description": "The Search service was successfully deleted." + "description": "The search service was successfully deleted." }, "404": { - "description": "The subscription, resource group, or Search service could not be found." + "description": "The subscription, resource group, or search service could not be found." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -608,7 +608,7 @@ ], "responses": { "200": { - "description": "The operation succeeded. The response contains the list of all Search service definitions for the given resource group.", + "description": "The operation succeeded. The response contains the list of all search service definitions for the given resource group.", "schema": { "$ref": "#/definitions/SearchServiceListResult" } @@ -684,7 +684,7 @@ "$ref": "./examples/UpdatePrivateEndpointConnection.json" } }, - "description": "Updates a Private Endpoint connection to the Search service in the given resource group.", + "description": "Updates a Private Endpoint connection to the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -742,7 +742,7 @@ "$ref": "./examples/GetPrivateEndpointConnection.json" } }, - "description": "Gets the details of the private endpoint connection to the Search service in the given resource group.", + "description": "Gets the details of the private endpoint connection to the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -774,7 +774,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, Search service or private endpoint connection could not be found.", + "description": "HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found.", "schema": { "$ref": "#/definitions/CloudError" } @@ -791,7 +791,7 @@ "$ref": "./examples/DeletePrivateEndpointConnection.json" } }, - "description": "Disconnects the private endpoint connection and deletes it from the Search service.", + "description": "Disconnects the private endpoint connection and deletes it from the search service.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -823,7 +823,7 @@ } }, "404": { - "description": "The subscription, resource group, Search service or private endpoint connection could not be found." + "description": "The subscription, resource group, search service or private endpoint connection could not be found." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -900,7 +900,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, - "description": "Initiates the creation or update of a shared private link resource managed by the Search service in the given resource group.", + "description": "Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -961,7 +961,7 @@ "$ref": "./examples/GetSharedPrivateLinkResource.json" } }, - "description": "Gets the details of the shared private link resource managed by the Search service in the given resource group.", + "description": "Gets the details of the shared private link resource managed by the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -993,7 +993,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, Search service or shared private link resource could not be found.", + "description": "HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found.", "schema": { "$ref": "#/definitions/CloudError" } @@ -1014,7 +1014,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, - "description": "Initiates the deletion of the shared private link resource from the Search service.", + "description": "Initiates the deletion of the shared private link resource from the search service.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -1046,7 +1046,7 @@ "description": "The backing private endpoint for the shared private link resource could not be found." }, "404": { - "description": "The subscription, resource group, Search service or shared private link resource could not be found." + "description": "The subscription, resource group, search service or shared private link resource could not be found." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -1139,7 +1139,7 @@ ], "responses": { "200": { - "description": "The operation succeeded. The response contains the list of all Search service definitions for the given subscription.", + "description": "The operation succeeded. The response contains the list of all search service definitions for the given subscription.", "schema": { "$ref": "#/definitions/SearchServiceListResult" } @@ -1158,7 +1158,7 @@ "tags": [ "Services" ], - "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).", + "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).", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -1215,7 +1215,7 @@ ], "properties": { "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.", + "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.", "type": "string" }, "type": { @@ -1267,12 +1267,12 @@ "primaryKey": { "readOnly": true, "type": "string", - "description": "The primary admin API key of the Search service." + "description": "The primary admin API key of the search service." }, "secondaryKey": { "readOnly": true, "type": "string", - "description": "The secondary admin API key of the Search service." + "description": "The secondary admin API key of the search service." } }, "description": "Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service." @@ -1315,7 +1315,7 @@ "properties": { "name": { "type": "string", - "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.'", + "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", "basic", @@ -1622,7 +1622,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SearchServiceProperties", - "description": "Properties of the Search service." + "description": "Properties of the search service." }, "sku": { "$ref": "#/definitions/Sku", @@ -1648,7 +1648,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SearchServiceProperties", - "description": "Properties of the Search service." + "description": "Properties of the search service." }, "sku": { "$ref": "#/definitions/Sku", @@ -1695,7 +1695,7 @@ "minimum": 1, "maximum": 12, "default": 1, - "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." + "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." }, "partitionCount": { "type": "integer", @@ -1703,7 +1703,7 @@ "minimum": 1, "maximum": 12, "default": 1, - "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." + "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." }, "hostingMode": { "type": "string", @@ -1734,7 +1734,7 @@ "status": { "readOnly": true, "type": "string", - "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.", + "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", "provisioning", @@ -1751,12 +1751,12 @@ "statusDetails": { "readOnly": true, "type": "string", - "description": "The details of the Search service status." + "description": "The details of the search service status." }, "provisioningState": { "readOnly": true, "type": "string", - "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.", + "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", "provisioning", @@ -1788,7 +1788,7 @@ "description": "The list of shared private link resources managed by the Azure Cognitive Search service." } }, - "description": "Properties of the Search service." + "description": "Properties of the search service." }, "SearchServiceListResult": { "properties": { @@ -2018,7 +2018,7 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for each request. The current version is 2019-10-01-Preview." + "description": "The API version to use for each request." } } } diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json index cacea5a54896..5b1307e54729 100644 --- a/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json +++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json @@ -1651,7 +1651,7 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for each request. The current version is 2019-10-01-Preview." + "description": "The API version to use for each request." } } } diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json b/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json index 45ff0bc70241..b7e40aba57e2 100644 --- a/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json +++ b/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json @@ -93,13 +93,13 @@ ], "responses": { "200": { - "description": "The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your Search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.", + "description": "The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.", "schema": { "$ref": "#/definitions/AdminKeyResult" } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -162,7 +162,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -181,7 +181,7 @@ "$ref": "./examples/SearchCreateQueryKey.json" } }, - "description": "Generates a new query key for the specified Search service. You can create up to 50 query keys per service.", + "description": "Generates a new query key for the specified search service. You can create up to 50 query keys per service.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -217,7 +217,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -262,13 +262,13 @@ ], "responses": { "200": { - "description": "All query keys for the given Search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.", + "description": "All query keys for the given search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.", "schema": { "$ref": "#/definitions/ListQueryKeysResult" } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", "schema": { "$ref": "#/definitions/CloudError" } @@ -323,7 +323,7 @@ "description": "The query key was successfully deleted." }, "404": { - "description": "The subscription, resource group, Search service, or query key could not be found." + "description": "The subscription, resource group, search service, or query key could not be found." }, "default": { "description": "HTTP 409 (Conflict): The specified subscription is disabled.", @@ -354,7 +354,7 @@ "$ref": "./examples/SearchCreateOrUpdateServiceWithIdentity.json" } }, - "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.", + "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.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -376,7 +376,7 @@ "schema": { "$ref": "#/definitions/SearchService" }, - "description": "The definition of the Search service to create or update." + "description": "The definition of the search service to create or update." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -396,7 +396,7 @@ } }, "201": { - "description": "If you requested creation of a free Search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", + "description": "If you requested creation of a free search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", "schema": { "$ref": "#/definitions/SearchService" } @@ -429,7 +429,7 @@ "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json" } }, - "description": "Updates an existing Search service in the given resource group.", + "description": "Updates an existing search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -451,7 +451,7 @@ "schema": { "$ref": "#/definitions/SearchServiceUpdate" }, - "description": "The definition of the Search service to update." + "description": "The definition of the search service to update." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -488,7 +488,7 @@ "$ref": "./examples/SearchGetService.json" } }, - "description": "Gets the Search service with the given name in the given resource group.", + "description": "Gets the search service with the given name in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -511,13 +511,13 @@ ], "responses": { "200": { - "description": "The Search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", + "description": "The search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", "schema": { "$ref": "#/definitions/SearchService" } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, or Search service name could not be found.", + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service name could not be found.", "schema": { "$ref": "#/definitions/CloudError" } @@ -534,7 +534,7 @@ "$ref": "./examples/SearchDeleteService.json" } }, - "description": "Deletes a Search service in the given resource group, along with its associated resources.", + "description": "Deletes a search service in the given resource group, along with its associated resources.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -557,13 +557,13 @@ ], "responses": { "200": { - "description": "The Search service was successfully deleted." + "description": "The search service was successfully deleted." }, "204": { - "description": "The Search service was successfully deleted." + "description": "The search service was successfully deleted." }, "404": { - "description": "The subscription, resource group, or Search service could not be found." + "description": "The subscription, resource group, or search service could not be found." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -588,7 +588,7 @@ "$ref": "./examples/SearchListServicesByResourceGroup.json" } }, - "description": "Gets a list of all Search services in the given resource group.", + "description": "Gets a list of all search services in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -608,7 +608,7 @@ ], "responses": { "200": { - "description": "The operation succeeded. The response contains the list of all Search service definitions for the given resource group.", + "description": "The operation succeeded. The response contains the list of all search service definitions for the given resource group.", "schema": { "$ref": "#/definitions/SearchServiceListResult" } @@ -684,7 +684,7 @@ "$ref": "./examples/UpdatePrivateEndpointConnection.json" } }, - "description": "Updates a Private Endpoint connection to the Search service in the given resource group.", + "description": "Updates a Private Endpoint connection to the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -742,7 +742,7 @@ "$ref": "./examples/GetPrivateEndpointConnection.json" } }, - "description": "Gets the details of the private endpoint connection to the Search service in the given resource group.", + "description": "Gets the details of the private endpoint connection to the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -774,7 +774,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, Search service or private endpoint connection could not be found.", + "description": "HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found.", "schema": { "$ref": "#/definitions/CloudError" } @@ -791,7 +791,7 @@ "$ref": "./examples/DeletePrivateEndpointConnection.json" } }, - "description": "Disconnects the private endpoint connection and deletes it from the Search service.", + "description": "Disconnects the private endpoint connection and deletes it from the search service.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -823,7 +823,7 @@ } }, "404": { - "description": "The subscription, resource group, Search service or private endpoint connection could not be found." + "description": "The subscription, resource group, search service or private endpoint connection could not be found." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -900,7 +900,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, - "description": "Initiates the creation or update of a shared private link resource managed by the Search service in the given resource group.", + "description": "Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -961,7 +961,7 @@ "$ref": "./examples/GetSharedPrivateLinkResource.json" } }, - "description": "Gets the details of the shared private link resource managed by the Search service in the given resource group.", + "description": "Gets the details of the shared private link resource managed by the search service in the given resource group.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -993,7 +993,7 @@ } }, "default": { - "description": "HTTP 404 (Not Found): The subscription, resource group, Search service or shared private link resource could not be found.", + "description": "HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found.", "schema": { "$ref": "#/definitions/CloudError" } @@ -1014,7 +1014,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, - "description": "Initiates the deletion of the shared private link resource from the Search service.", + "description": "Initiates the deletion of the shared private link resource from the search service.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -1046,7 +1046,7 @@ "description": "The backing private endpoint for the shared private link resource could not be found." }, "404": { - "description": "The subscription, resource group, Search service or shared private link resource could not be found." + "description": "The subscription, resource group, search service or shared private link resource could not be found." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -1122,7 +1122,7 @@ "$ref": "./examples/SearchListServicesBySubscription.json" } }, - "description": "Gets a list of all Search services in the given subscription.", + "description": "Gets a list of all search services in the given subscription.", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -1139,7 +1139,7 @@ ], "responses": { "200": { - "description": "The operation succeeded. The response contains the list of all Search service definitions for the given subscription.", + "description": "The operation succeeded. The response contains the list of all search service definitions for the given subscription.", "schema": { "$ref": "#/definitions/SearchServiceListResult" } @@ -1158,7 +1158,7 @@ "tags": [ "Services" ], - "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).", + "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).", "externalDocs": { "url": "https://aka.ms/search-manage" }, @@ -1215,7 +1215,7 @@ ], "properties": { "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.", + "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.", "type": "string" }, "type": { @@ -1267,12 +1267,12 @@ "primaryKey": { "readOnly": true, "type": "string", - "description": "The primary admin API key of the Search service." + "description": "The primary admin API key of the search service." }, "secondaryKey": { "readOnly": true, "type": "string", - "description": "The secondary admin API key of the Search service." + "description": "The secondary admin API key of the search service." } }, "description": "Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service." @@ -1315,7 +1315,7 @@ "properties": { "name": { "type": "string", - "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.'", + "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", "basic", @@ -1622,7 +1622,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SearchServiceProperties", - "description": "Properties of the Search service." + "description": "Properties of the search service." }, "sku": { "$ref": "#/definitions/Sku", @@ -1648,7 +1648,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SearchServiceProperties", - "description": "Properties of the Search service." + "description": "Properties of the search service." }, "sku": { "$ref": "#/definitions/Sku", @@ -1695,7 +1695,7 @@ "minimum": 1, "maximum": 12, "default": 1, - "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." + "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." }, "partitionCount": { "type": "integer", @@ -1703,7 +1703,7 @@ "minimum": 1, "maximum": 12, "default": 1, - "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." + "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." }, "hostingMode": { "type": "string", @@ -1734,7 +1734,7 @@ "status": { "readOnly": true, "type": "string", - "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.", + "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", "provisioning", @@ -1751,12 +1751,12 @@ "statusDetails": { "readOnly": true, "type": "string", - "description": "The details of the Search service status." + "description": "The details of the search service status." }, "provisioningState": { "readOnly": true, "type": "string", - "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.", + "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", "provisioning", @@ -1788,7 +1788,7 @@ "description": "The list of shared private link resources managed by the Azure Cognitive Search service." } }, - "description": "Properties of the Search service." + "description": "Properties of the search service." }, "SearchServiceListResult": { "properties": { @@ -1798,7 +1798,7 @@ "items": { "$ref": "#/definitions/SearchService" }, - "description": "The list of Search services." + "description": "The list of search services." }, "nextLink": { "readOnly": true, @@ -2018,7 +2018,7 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for each request. The current version is 2019-10-01-Preview." + "description": "The API version to use for each request." } } }