@azure/search-documents 11.3.0-beta.6 → 11.3.0-beta.7

package/types/search-documents.d.ts

@@ -8,6 +8,13 @@ import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
+/**
+ * An iterator for listing the aliases that exist in the Search service. Will make requests
+ * as needed during iteration. Use .byPage() to make one request to the server
+ * per iteration.
+ */
+export declare type AliasIterator = PagedAsyncIterableIterator<SearchIndexAlias, SearchIndexAlias[], {}>;
+
 /** Information about a token returned by an analyzer. */
 export declare interface AnalyzedTokenInfo {
     /**
@@ -530,6 +537,11 @@ export declare interface CorsOptions {
  */
 export declare type CountDocumentsOptions = OperationOptions;
 
+/**
+ * Options for create alias operation.
+ */
+export declare type CreateAliasOptions = OperationOptions;
+
 /**
  * Options for create datasource operation.
  */
@@ -545,6 +557,16 @@ export declare type CreateIndexerOptions = OperationOptions;
  */
 export declare type CreateIndexOptions = OperationOptions;
 
+/**
+ * Options for create or update alias operation.
+ */
+export declare interface CreateOrUpdateAliasOptions extends OperationOptions {
+    /**
+     * If set to true, Resource will be deleted only if the etag matches.
+     */
+    onlyIfUnchanged?: boolean;
+}
+
 /**
  * Options for create/update datasource operation.
  */
@@ -788,6 +810,16 @@ export declare type DefaultCognitiveServicesAccount = BaseCognitiveServicesAccou
     odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices";
 };
 
+/**
+ * Options for delete alias operation.
+ */
+export declare interface DeleteAliasOptions extends OperationOptions {
+    /**
+     * If set to true, Resource will be deleted only if the etag matches.
+     */
+    onlyIfUnchanged?: boolean;
+}
+
 /**
  * Options for delete datasource operation.
  */
@@ -1101,6 +1133,11 @@ export declare class GeographyPoint {
     toJSON(): Record<string, unknown>;
 }
 
+/**
+ * Options for get alias operation.
+ */
+export declare type GetAliasOptions = OperationOptions;
+
 /**
  * Options for get datasource operation.
  */
@@ -3442,6 +3479,11 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
  */
 export declare type LineEnding = string;
 
+/**
+ * Options for list aliases operation.
+ */
+export declare type ListAliasesOptions = OperationOptions;
+
 /**
  * Options for a list data sources operation.
  */
@@ -4063,6 +4105,16 @@ export declare interface ScoringProfile {
 /** Defines values for ScoringStatistics. */
 export declare type ScoringStatistics = "local" | "global";
 
+/** Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. */
+export declare interface SearchAlias {
+    /** The name of the alias. */
+    name: string;
+    /** The name of the index this alias maps to. Only one index name may be specified. */
+    indexes: string[];
+    /** The ETag of the alias. */
+    etag?: string;
+}
+
 /**
  * Class used to perform operations against a search index,
  * including querying documents in the index as well as
@@ -4367,6 +4419,11 @@ export declare interface SearchIndex {
     etag?: string;
 }
 
+/**
+ * Search Alias object.
+ */
+export declare type SearchIndexAlias = SearchAlias;
+
 /**
  * Class to perform operations to manage
  * (create, update, list/delete)
@@ -4419,6 +4476,13 @@ export declare class SearchIndexClient {
      * @param options - Options to the list index operation.
      */
     listIndexes(options?: ListIndexesOptions): IndexIterator;
+    private listAliasesPage;
+    private listAliasesAll;
+    /**
+     * Lists all aliases available for a search service.
+     * @param options - The options parameters.
+     */
+    listAliases(options?: ListAliasesOptions): AliasIterator;
     private listIndexesNamesPage;
     private listIndexesNamesAll;
     /**
@@ -4484,6 +4548,31 @@ export declare class SearchIndexClient {
      * @param options - Additional optional arguments.
      */
     deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>;
+    /**
+     * Creates a new search alias or updates an alias if it already exists.
+     * @param alias - The definition of the alias to create or update.
+     * @param options - The options parameters.
+     */
+    createOrUpdateAlias(alias: SearchIndexAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchIndexAlias>;
+    /**
+     * Creates a new search alias.
+     * @param alias - The definition of the alias to create.
+     * @param options - The options parameters.
+     */
+    createAlias(alias: SearchIndexAlias, options?: CreateAliasOptions): Promise<SearchIndexAlias>;
+    /**
+     * Deletes a search alias and its associated mapping to an index. This operation is permanent, with no
+     * recovery option. The mapped index is untouched by this operation.
+     * @param alias - Alias/Name name of the alias to delete.
+     * @param options - The options parameters.
+     */
+    deleteAlias(alias: string | SearchIndexAlias, options?: DeleteAliasOptions): Promise<void>;
+    /**
+     * Retrieves an alias definition.
+     * @param aliasName - The name of the alias to retrieve.
+     * @param options - The options parameters.
+     */
+    getAlias(aliasName: string, options?: GetAliasOptions): Promise<SearchIndexAlias>;
     /**
      * Retrieves statistics about an index, such as the count of documents and the size
      * of index storage.
@@ -5782,6 +5871,8 @@ export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
 
 /** Represents service-level resource counters and quotas. */
 export declare interface ServiceCounters {
+    /** Total number of aliases. */
+    aliasCounter?: ResourceCounter;
     /** Total number of documents across all indexes in the service. */
     documentCounter: ResourceCounter;
     /** Total number of indexes. */