diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/Models/ExtensibleEnum.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/Models/ExtensibleEnum.cs index 333e61e647cb..366e3f6ed1a4 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/Models/ExtensibleEnum.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/Models/ExtensibleEnum.cs @@ -70,7 +70,7 @@ protected static T Lookup(string name) /// Compares the ExtensibleEnum for equality with another ExtensibleEnum. /// /// The ExtensibleEnum with which to compare. - /// true if the ExtensibleEnum objects are equal; false otherwise. + /// true if the ExtensibleEnum objects are equal; otherwise, false. public bool Equals(T other) { if (object.ReferenceEquals(other, null)) @@ -81,13 +81,20 @@ public bool Equals(T other) return this._name == other._name; } - /// + /// + /// Determines whether the specified object is equal to the current object. + /// + /// The object to compare with the current object. + /// true if the specified object is equal to the current object; otherwise, false. public override bool Equals(object obj) { return this.Equals(obj as T); } - /// + /// + /// Serves as the default hash function. + /// + /// A hash code for the current object. public override int GetHashCode() { return _name.GetHashCode(); diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/SearchCredentials.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/SearchCredentials.cs index 38344fe3d586..826958dc954c 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/SearchCredentials.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Common/Customizations/Search/SearchCredentials.cs @@ -14,6 +14,9 @@ namespace Microsoft.Azure.Search /// Credentials used to authenticate to an Azure Search service. /// /// + /// + /// See for more information about API keys in Azure Search. + /// public class SearchCredentials : ServiceClientCredentials { /// diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/ISearchIndexClient.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/ISearchIndexClient.Customization.cs index 0ff1a63ef8b6..a51b4feee126 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/ISearchIndexClient.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/ISearchIndexClient.Customization.cs @@ -9,8 +9,11 @@ namespace Microsoft.Azure.Search public partial interface ISearchIndexClient { /// - /// Gets the credentials used to authenticate to an Azure Search service. + /// Gets the credentials used to authenticate to an Azure Search service. This can be either a query API key or an admin API key. /// + /// + /// See for more information about API keys in Azure Search. + /// SearchCredentials SearchCredentials { get; } /// diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/SearchIndexClient.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/SearchIndexClient.Customization.cs index 2c604358f684..c36ef64fb6a7 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/SearchIndexClient.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Data/Customizations/SearchIndexClient.Customization.cs @@ -51,13 +51,25 @@ public SearchIndexClient( Initialize(searchServiceName, indexName, credentials); } - /// + /// + /// Gets the credentials used to authenticate to an Azure Search service. This can be either a query API key or an admin API key. + /// + /// + /// See for more information about API keys in Azure Search. + /// public SearchCredentials SearchCredentials => (SearchCredentials)Credentials; - /// + /// + /// Indicates whether the index client should use HTTP GET for making Search and Suggest requests to the + /// Azure Search REST API. The default is false, which indicates that HTTP POST will be used. + /// public bool UseHttpGetForQueries { get; set; } - /// + /// + /// Changes the BaseUri of this client to target a different index in the same Azure Search service. This method is NOT thread-safe; You + /// must guarantee that no other threads are using the client before calling it. + /// + /// The name of the index to which all subsequent requests should be sent. [Obsolete("This method is deprecated. Please set the IndexName property instead.")] public void TargetDifferentIndex(string newIndexName) { diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourceOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourceOperations.Customization.cs index 0a0d74fbfc88..71d7a3f203eb 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourceOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourceOperations.Customization.cs @@ -12,13 +12,76 @@ namespace Microsoft.Azure.Search internal partial class DataSourcesOperations { - /// + /// + /// Creates a new Azure Search datasource or updates a datasource if it already + /// exists. + /// + /// + /// + /// The definition of the datasource to create or update. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response object containing the response body and response headers. + /// public Task> CreateOrUpdateWithHttpMessagesAsync(DataSource dataSource, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)) { return CreateOrUpdateWithHttpMessagesAsync(dataSource?.Name, dataSource, searchRequestOptions, accessCondition, customHeaders, cancellationToken); } - /// + /// + /// Determines whether or not the given data source exists in the Azure Search service. + /// + /// + /// The name of the data source. + /// + /// + /// Additional parameters for the operation + /// + /// + /// The headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response with the value true if the data source exists; false otherwise. + /// public Task> ExistsWithHttpMessagesAsync( string dataSourceName, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourcesOperationsExtensions.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourcesOperationsExtensions.Customization.cs index 1b123b72b4db..4c7d77d81c14 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourcesOperationsExtensions.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/DataSourcesOperationsExtensions.Customization.cs @@ -16,8 +16,9 @@ namespace Microsoft.Azure.Search public static partial class DataSourcesOperationsExtensions { /// - /// Creates a new Azure Search datasource or updates a datasource if it - /// already exists. + /// Creates a new Azure Search datasource or updates a datasource if it already + /// exists. + /// /// /// /// The operations group for this extension method. @@ -26,19 +27,23 @@ public static partial class DataSourcesOperationsExtensions /// The definition of the datasource to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// + /// + /// The datasource that was created or updated. + /// public static DataSource CreateOrUpdate(this IDataSourcesOperations operations, DataSource dataSource, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition)) { return operations.CreateOrUpdateAsync(dataSource, searchRequestOptions, accessCondition).GetAwaiter().GetResult(); } /// - /// Creates a new Azure Search datasource or updates a datasource if it - /// already exists. + /// Creates a new Azure Search datasource or updates a datasource if it already + /// exists. + /// /// /// /// The operations group for this extension method. @@ -55,6 +60,9 @@ public static partial class DataSourcesOperationsExtensions /// /// The cancellation token. /// + /// + /// The datasource that was created or updated. + /// public static async Task CreateOrUpdateAsync(this IDataSourcesOperations operations, DataSource dataSource, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), CancellationToken cancellationToken = default(CancellationToken)) { using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(dataSource, searchRequestOptions, accessCondition, null, cancellationToken).ConfigureAwait(false)) @@ -73,7 +81,7 @@ public static partial class DataSourcesOperationsExtensions /// The name of the data source. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// true if the data source exists; false otherwise. @@ -96,7 +104,7 @@ public static bool Exists( /// The name of the data source. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/IDataSourcesOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/IDataSourcesOperations.Customization.cs index 87b7816b94a1..1cc245b1fa06 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/IDataSourcesOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/DataSources/IDataSourcesOperations.Customization.cs @@ -13,24 +13,40 @@ namespace Microsoft.Azure.Search public partial interface IDataSourcesOperations { /// - /// Creates a new Azure Search datasource or updates a datasource if - /// it already exists. + /// Creates a new Azure Search datasource or updates a datasource if it already + /// exists. + /// /// /// /// The definition of the datasource to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// The headers that will be added to request. + /// Headers that will be added to request. /// /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response object containing the response body and response headers. + /// Task> CreateOrUpdateWithHttpMessagesAsync(DataSource dataSource, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// @@ -40,7 +56,7 @@ public partial interface IDataSourcesOperations /// The name of the data source. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The headers that will be added to request. @@ -48,6 +64,18 @@ public partial interface IDataSourcesOperations /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// /// /// A response with the value true if the data source exists; false otherwise. /// diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/ISearchServiceClient.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/ISearchServiceClient.Customization.cs index 59b1f3e5875e..fa007f0c7edb 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/ISearchServiceClient.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/ISearchServiceClient.Customization.cs @@ -9,8 +9,11 @@ namespace Microsoft.Azure.Search public partial interface ISearchServiceClient { /// - /// Gets the credentials used to authenticate to an Azure Search service. + /// Gets the credentials used to authenticate to an Azure Search service. This can be either a query API key or an admin API key. /// + /// + /// See for more information about API keys in Azure Search. + /// SearchCredentials SearchCredentials { get; } } } diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IIndexersOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IIndexersOperations.Customization.cs index d7069d512e25..a0e7a5a2ab17 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IIndexersOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IIndexersOperations.Customization.cs @@ -13,8 +13,9 @@ namespace Microsoft.Azure.Search public partial interface IIndexersOperations { /// - /// Creates a new Azure Search indexer or updates an indexer if it - /// already exists. + /// Creates a new Azure Search indexer or updates an indexer if it already + /// exists. + /// /// /// /// The definition of the indexer to create or update. @@ -26,11 +27,26 @@ public partial interface IIndexersOperations /// Additional parameters for the operation /// /// - /// The headers that will be added to request. + /// Headers that will be added to request. /// /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response object containing the response body and response headers. + /// Task> CreateOrUpdateWithHttpMessagesAsync(Indexer indexer, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// @@ -40,7 +56,7 @@ public partial interface IIndexersOperations /// The name of the indexer. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The headers that will be added to request. @@ -48,6 +64,18 @@ public partial interface IIndexersOperations /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// /// /// A response with the value true if the indexer exists; false otherwise. /// diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperations.Customization.cs index e35181b69c3f..47c5c4bfd09c 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperations.Customization.cs @@ -12,13 +12,76 @@ namespace Microsoft.Azure.Search internal partial class IndexersOperations { - /// + /// + /// Creates a new Azure Search indexer or updates an indexer if it already + /// exists. + /// + /// + /// + /// The definition of the indexer to create or update. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response object containing the response body and response headers. + /// public Task> CreateOrUpdateWithHttpMessagesAsync(Indexer indexer, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)) { return CreateOrUpdateWithHttpMessagesAsync(indexer?.Name, indexer, searchRequestOptions, accessCondition, customHeaders, cancellationToken); } - - /// + + /// + /// Determines whether or not the given indexer exists in the Azure Search service. + /// + /// + /// The name of the indexer. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// The headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response with the value true if the indexer exists; false otherwise. + /// public Task> ExistsWithHttpMessagesAsync( string indexerName, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperationsExtensions.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperationsExtensions.Customization.cs index 13d77fc2f322..4354d74b9c86 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperationsExtensions.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexers/IndexersOperationsExtensions.Customization.cs @@ -18,6 +18,7 @@ public static partial class IndexersOperationsExtensions /// /// Creates a new Azure Search indexer or updates an indexer if it already /// exists. + /// /// /// /// The operations group for this extension method. @@ -26,11 +27,14 @@ public static partial class IndexersOperationsExtensions /// The definition of the indexer to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// + /// + /// The indexer that was created or updated. + /// public static Indexer CreateOrUpdate(this IIndexersOperations operations, Indexer indexer, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition)) { return operations.CreateOrUpdateAsync(indexer, searchRequestOptions, accessCondition).GetAwaiter().GetResult(); @@ -39,6 +43,7 @@ public static partial class IndexersOperationsExtensions /// /// Creates a new Azure Search indexer or updates an indexer if it already /// exists. + /// /// /// /// The operations group for this extension method. @@ -47,14 +52,17 @@ public static partial class IndexersOperationsExtensions /// The definition of the indexer to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. /// + /// + /// The indexer that was created or updated. + /// public static async Task CreateOrUpdateAsync(this IIndexersOperations operations, Indexer indexer, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), CancellationToken cancellationToken = default(CancellationToken)) { using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(indexer, searchRequestOptions, accessCondition, null, cancellationToken).ConfigureAwait(false)) @@ -73,7 +81,7 @@ public static partial class IndexersOperationsExtensions /// The name of the indexer. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// true if the indexer exists; false otherwise. @@ -96,7 +104,7 @@ public static bool Exists( /// The name of the indexer. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IIndexesOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IIndexesOperations.Customization.cs index bd463462a47b..61b76783ae8e 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IIndexesOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IIndexesOperations.Customization.cs @@ -18,32 +18,46 @@ public partial interface IIndexesOperations SearchServiceClient Client { get; } /// - /// Creates a new Azure Search index or updates an index if it already - /// exists. + /// Creates a new Azure Search index or updates an index if it already exists. + /// /// /// /// The definition of the index to create or update. /// /// - /// Allows new analyzers, tokenizers, token filters, or char filters - /// to be added to an index by taking the index offline for at least - /// a few seconds. This temporarily causes indexing and query - /// requests to fail. Performance and write availability of the index - /// can be impaired for several minutes after the index is updated, - /// or longer for very large indexes. + /// Allows new analyzers, tokenizers, token filters, or char filters to be + /// added to an index by taking the index offline for at least a few seconds. + /// This temporarily causes indexing and query requests to fail. Performance + /// and write availability of the index can be impaired for several minutes + /// after the index is updated, or longer for very large indexes. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// The headers that will be added to request. + /// Headers that will be added to request. /// /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null + /// + /// + /// A response object containing the response body and response headers. + /// Task> CreateOrUpdateWithHttpMessagesAsync(Index index, bool? allowIndexDowntime = default(bool?), SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// @@ -53,7 +67,7 @@ public partial interface IIndexesOperations /// The name of the index. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The headers that will be added to request. @@ -61,6 +75,18 @@ public partial interface IIndexesOperations /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// /// /// A response with the value true if the index exists; false otherwise. /// diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperations.Customization.cs index ee56a0a2405d..5b8c0ad5adca 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperations.Customization.cs @@ -12,13 +12,82 @@ namespace Microsoft.Azure.Search internal partial class IndexesOperations { - /// + /// + /// Creates a new Azure Search index or updates an index if it already exists. + /// + /// + /// + /// The definition of the index to create or update. + /// + /// + /// Allows new analyzers, tokenizers, token filters, or char filters to be + /// added to an index by taking the index offline for at least a few seconds. + /// This temporarily causes indexing and query requests to fail. Performance + /// and write availability of the index can be impaired for several minutes + /// after the index is updated, or longer for very large indexes. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null + /// + /// + /// A response object containing the response body and response headers. + /// public Task> CreateOrUpdateWithHttpMessagesAsync(Index index, bool? allowIndexDowntime = default(bool?), SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)) { return CreateOrUpdateWithHttpMessagesAsync(index != null ? index.Name : null, index, allowIndexDowntime, searchRequestOptions, accessCondition, customHeaders, cancellationToken); } - - /// + + /// + /// Determines whether or not the given index exists in the Azure Search service. + /// + /// + /// The name of the index. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// The headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null + /// + /// + /// A response with the value true if the index exists; false otherwise. + /// public Task> ExistsWithHttpMessagesAsync( string indexName, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperationsExtensions.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperationsExtensions.Customization.cs index 643722e463f9..4b727b2d4852 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperationsExtensions.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/Indexes/IndexesOperationsExtensions.Customization.cs @@ -19,6 +19,7 @@ public static partial class IndexesOperationsExtensions { /// /// Creates a new Azure Search index or updates an index if it already exists. + /// /// /// /// The operations group for this extension method. @@ -35,11 +36,14 @@ public static partial class IndexesOperationsExtensions /// or longer for very large indexes. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// + /// + /// The index that was created or updated. + /// public static Index CreateOrUpdate(this IIndexesOperations operations, Index index, bool? allowIndexDowntime = default(bool?), SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition)) { return operations.CreateOrUpdateAsync(index, allowIndexDowntime, searchRequestOptions, accessCondition).GetAwaiter().GetResult(); @@ -47,6 +51,7 @@ public static partial class IndexesOperationsExtensions /// /// Creates a new Azure Search index or updates an index if it already exists. + /// /// /// /// The operations group for this extension method. @@ -63,14 +68,17 @@ public static partial class IndexesOperationsExtensions /// or longer for very large indexes. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. /// + /// + /// The index that was created or updated. + /// public static async Task CreateOrUpdateAsync(this IIndexesOperations operations, Index index, bool? allowIndexDowntime = default(bool?), SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), CancellationToken cancellationToken = default(CancellationToken)) { using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(index, allowIndexDowntime, searchRequestOptions, accessCondition, null, cancellationToken).ConfigureAwait(false)) @@ -89,7 +97,7 @@ public static partial class IndexesOperationsExtensions /// The name of the index. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// true if the index exists; false otherwise. @@ -112,7 +120,7 @@ public static bool Exists( /// The name of the index. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. @@ -141,7 +149,7 @@ public static async Task ExistsAsync( /// The operations group for this extension method. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The list of all index names for the search service. @@ -164,7 +172,7 @@ public static IList ListNames( /// The operations group for this extension method. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SearchServiceClient.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SearchServiceClient.Customization.cs index f607e9c283d3..05c39b52155b 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SearchServiceClient.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SearchServiceClient.Customization.cs @@ -47,7 +47,12 @@ public SearchServiceClient(string searchServiceName, SearchCredentials credentia Initialize(searchServiceName, credentials); } - /// + /// + /// Gets the credentials used to authenticate to an Azure Search service. This can be either a query API key or an admin API key. + /// + /// + /// See for more information about API keys in Azure Search. + /// public SearchCredentials SearchCredentials => (SearchCredentials)Credentials; private void Initialize(string searchServiceName, SearchCredentials credentials) diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/ISynonymMapsOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/ISynonymMapsOperations.Customization.cs index 6444a6b5eaa3..589b4446a8ab 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/ISynonymMapsOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/ISynonymMapsOperations.Customization.cs @@ -13,24 +13,40 @@ namespace Microsoft.Azure.Search public partial interface ISynonymMapsOperations { /// - /// Creates a new Azure Search synonymmap or updates a synonymmap if - /// it already exists. + /// Creates a new Azure Search synonym map or updates a synonym map if it + /// already exists. + /// /// /// - /// The definition of the synonymmap to create or update. + /// The definition of the synonym map to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// The headers that will be added to request. + /// Headers that will be added to request. /// /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response object containing the response body and response headers. + /// Task> CreateOrUpdateWithHttpMessagesAsync(SynonymMap synonymMap, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// @@ -40,7 +56,7 @@ public partial interface ISynonymMapsOperations /// The name of the synonym map. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The headers that will be added to request. @@ -48,6 +64,18 @@ public partial interface ISynonymMapsOperations /// /// The cancellation token. /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// /// /// A response with the value true if the synonym map exists; false otherwise. /// diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperations.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperations.Customization.cs index 944d1d3d70f1..ffea2693c3c2 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperations.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperations.Customization.cs @@ -12,13 +12,76 @@ namespace Microsoft.Azure.Search internal partial class SynonymMapsOperations { - /// + /// + /// Creates a new Azure Search synonym map or updates a synonym map if it + /// already exists. + /// + /// + /// + /// The definition of the synonym map to create or update. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Additional parameters for the operation. + /// + /// + /// Headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response object containing the response body and response headers. + /// public Task> CreateOrUpdateWithHttpMessagesAsync(SynonymMap synonymMap, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)) { return CreateOrUpdateWithHttpMessagesAsync(synonymMap?.Name, synonymMap, searchRequestOptions, accessCondition, customHeaders, cancellationToken); } - /// + /// + /// Determines whether or not the given synonym map exists in the Azure Search service. + /// + /// + /// The name of the synonym map. + /// + /// + /// Additional parameters for the operation + /// + /// + /// The headers that will be added to request. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when unable to deserialize the response. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// Thrown when a required parameter is null. + /// + /// + /// A response with the value true if the synonym map exists; false otherwise. + /// public Task> ExistsWithHttpMessagesAsync( string synonymMapName, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), diff --git a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperationsExtensions.Customization.cs b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperationsExtensions.Customization.cs index 538f25c67a7d..dc68511a80e5 100644 --- a/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperationsExtensions.Customization.cs +++ b/src/SDKs/Search/DataPlane/Microsoft.Azure.Search.Service/Customizations/SynonymMaps/SynonymMapsOperationsExtensions.Customization.cs @@ -15,8 +15,9 @@ namespace Microsoft.Azure.Search public static partial class SynonymMapsOperationsExtensions { /// - /// Creates a new Azure Search synonymmap or updates a synonymmap if it + /// Creates a new Azure Search synonym map or updates a synonym map if it /// already exists. + /// /// /// /// The operations group for this extension method. @@ -25,19 +26,21 @@ public static partial class SynonymMapsOperationsExtensions /// The definition of the synonymmap to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// + /// The synonym map that was created or updated. public static SynonymMap CreateOrUpdate(this ISynonymMapsOperations operations, SynonymMap synonymMap, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition)) { return operations.CreateOrUpdateAsync(synonymMap, searchRequestOptions, accessCondition).GetAwaiter().GetResult(); } /// - /// Creates a new Azure Search synonymmap or updates a synonymmap if it + /// Creates a new Azure Search synonym map or updates a synonym map if it /// already exists. + /// /// /// /// The operations group for this extension method. @@ -46,14 +49,15 @@ public static partial class SynonymMapsOperationsExtensions /// The definition of the synonymmap to create or update. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token. /// + /// The synonym map that was created or updated. public static async Task CreateOrUpdateAsync(this ISynonymMapsOperations operations, SynonymMap synonymMap, SearchRequestOptions searchRequestOptions = default(SearchRequestOptions), AccessCondition accessCondition = default(AccessCondition), CancellationToken cancellationToken = default(CancellationToken)) { using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(synonymMap, searchRequestOptions, accessCondition, null, cancellationToken).ConfigureAwait(false)) @@ -72,7 +76,7 @@ public static partial class SynonymMapsOperationsExtensions /// The name of the synonym map. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// true if the synonym map exists; false otherwise. @@ -95,7 +99,7 @@ public static bool Exists( /// The name of the synonym map. /// /// - /// Additional parameters for the operation + /// Additional parameters for the operation. /// /// /// The cancellation token.