@azure/arm-search 1.3.0 → 3.0.0-beta.1

package/src/operations/queryKeys.ts

@@ -0,0 +1,288 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { QueryKeys } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { SearchManagementClient } from "../searchManagementClient";
+import {
+  QueryKey,
+  QueryKeysListBySearchServiceNextOptionalParams,
+  QueryKeysListBySearchServiceOptionalParams,
+  QueryKeysCreateOptionalParams,
+  QueryKeysCreateResponse,
+  QueryKeysListBySearchServiceResponse,
+  QueryKeysDeleteOptionalParams,
+  QueryKeysListBySearchServiceNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing QueryKeys operations. */
+export class QueryKeysImpl implements QueryKeys {
+  private readonly client: SearchManagementClient;
+
+  /**
+   * Initialize a new instance of the class QueryKeys class.
+   * @param client Reference to the service client
+   */
+  constructor(client: SearchManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Returns the list of query API keys for the given Azure Cognitive Search service.
+   * @param resourceGroupName The name of the resource group within the current subscription. You can
+   *                          obtain this value from the Azure Resource Manager API or the portal.
+   * @param searchServiceName The name of the Azure Cognitive Search service associated with the
+   *                          specified resource group.
+   * @param options The options parameters.
+   */
+  public listBySearchService(
+    resourceGroupName: string,
+    searchServiceName: string,
+    options?: QueryKeysListBySearchServiceOptionalParams
+  ): PagedAsyncIterableIterator<QueryKey> {
+    const iter = this.listBySearchServicePagingAll(
+      resourceGroupName,
+      searchServiceName,
+      options
+    );
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: () => {
+        return this.listBySearchServicePagingPage(
+          resourceGroupName,
+          searchServiceName,
+          options
+        );
+      }
+    };
+  }
+
+  private async *listBySearchServicePagingPage(
+    resourceGroupName: string,
+    searchServiceName: string,
+    options?: QueryKeysListBySearchServiceOptionalParams
+  ): AsyncIterableIterator<QueryKey[]> {
+    let result = await this._listBySearchService(
+      resourceGroupName,
+      searchServiceName,
+      options
+    );
+    yield result.value || [];
+    let continuationToken = result.nextLink;
+    while (continuationToken) {
+      result = await this._listBySearchServiceNext(
+        resourceGroupName,
+        searchServiceName,
+        continuationToken,
+        options
+      );
+      continuationToken = result.nextLink;
+      yield result.value || [];
+    }
+  }
+
+  private async *listBySearchServicePagingAll(
+    resourceGroupName: string,
+    searchServiceName: string,
+    options?: QueryKeysListBySearchServiceOptionalParams
+  ): AsyncIterableIterator<QueryKey> {
+    for await (const page of this.listBySearchServicePagingPage(
+      resourceGroupName,
+      searchServiceName,
+      options
+    )) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Generates a new query key for the specified search service. You can create up to 50 query keys per
+   * service.
+   * @param resourceGroupName The name of the resource group within the current subscription. You can
+   *                          obtain this value from the Azure Resource Manager API or the portal.
+   * @param searchServiceName The name of the Azure Cognitive Search service associated with the
+   *                          specified resource group.
+   * @param name The name of the new query API key.
+   * @param options The options parameters.
+   */
+  create(
+    resourceGroupName: string,
+    searchServiceName: string,
+    name: string,
+    options?: QueryKeysCreateOptionalParams
+  ): Promise<QueryKeysCreateResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, searchServiceName, name, options },
+      createOperationSpec
+    );
+  }
+
+  /**
+   * Returns the list of query API keys for the given Azure Cognitive Search service.
+   * @param resourceGroupName The name of the resource group within the current subscription. You can
+   *                          obtain this value from the Azure Resource Manager API or the portal.
+   * @param searchServiceName The name of the Azure Cognitive Search service associated with the
+   *                          specified resource group.
+   * @param options The options parameters.
+   */
+  private _listBySearchService(
+    resourceGroupName: string,
+    searchServiceName: string,
+    options?: QueryKeysListBySearchServiceOptionalParams
+  ): Promise<QueryKeysListBySearchServiceResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, searchServiceName, options },
+      listBySearchServiceOperationSpec
+    );
+  }
+
+  /**
+   * Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for
+   * regenerating a query key is to delete and then recreate it.
+   * @param resourceGroupName The name of the resource group within the current subscription. You can
+   *                          obtain this value from the Azure Resource Manager API or the portal.
+   * @param searchServiceName The name of the Azure Cognitive Search service associated with the
+   *                          specified resource group.
+   * @param key The query key to be deleted. Query keys are identified by value, not by name.
+   * @param options The options parameters.
+   */
+  delete(
+    resourceGroupName: string,
+    searchServiceName: string,
+    key: string,
+    options?: QueryKeysDeleteOptionalParams
+  ): Promise<void> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, searchServiceName, key, options },
+      deleteOperationSpec
+    );
+  }
+
+  /**
+   * ListBySearchServiceNext
+   * @param resourceGroupName The name of the resource group within the current subscription. You can
+   *                          obtain this value from the Azure Resource Manager API or the portal.
+   * @param searchServiceName The name of the Azure Cognitive Search service associated with the
+   *                          specified resource group.
+   * @param nextLink The nextLink from the previous successful call to the ListBySearchService method.
+   * @param options The options parameters.
+   */
+  private _listBySearchServiceNext(
+    resourceGroupName: string,
+    searchServiceName: string,
+    nextLink: string,
+    options?: QueryKeysListBySearchServiceNextOptionalParams
+  ): Promise<QueryKeysListBySearchServiceNextResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, searchServiceName, nextLink, options },
+      listBySearchServiceNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const createOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.QueryKey
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.searchServiceName,
+    Parameters.subscriptionId,
+    Parameters.name
+  ],
+  headerParameters: [Parameters.accept, Parameters.clientRequestId],
+  serializer
+};
+const listBySearchServiceOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ListQueryKeysResult
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.searchServiceName,
+    Parameters.subscriptionId
+  ],
+  headerParameters: [Parameters.accept, Parameters.clientRequestId],
+  serializer
+};
+const deleteOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}",
+  httpMethod: "DELETE",
+  responses: {
+    200: {},
+    204: {},
+    404: {},
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.searchServiceName,
+    Parameters.subscriptionId,
+    Parameters.key
+  ],
+  headerParameters: [Parameters.accept, Parameters.clientRequestId],
+  serializer
+};
+const listBySearchServiceNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ListQueryKeysResult
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.searchServiceName,
+    Parameters.subscriptionId,
+    Parameters.nextLink
+  ],
+  headerParameters: [Parameters.accept, Parameters.clientRequestId],
+  serializer
+};