@azure/arm-search 4.0.0-beta.1 → 4.0.0-beta.2

package/src/operationsInterfaces/services.ts

@@ -1,144 +0,0 @@
-/*
- * 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 { SimplePollerLike, OperationState } from "@azure/core-lro";
-import {
-  SearchService,
-  ServicesListByResourceGroupOptionalParams,
-  ServicesListBySubscriptionOptionalParams,
-  ServicesCreateOrUpdateOptionalParams,
-  ServicesCreateOrUpdateResponse,
-  SearchServiceUpdate,
-  ServicesUpdateOptionalParams,
-  ServicesUpdateResponse,
-  ServicesGetOptionalParams,
-  ServicesGetResponse,
-  ServicesDeleteOptionalParams,
-  ServicesCheckNameAvailabilityOptionalParams,
-  ServicesCheckNameAvailabilityResponse,
-} from "../models";
-
-/// <reference lib="esnext.asynciterable" />
-/** Interface representing a Services. */
-export interface Services {
-  /**
-   * Gets a list of all Search services in the given resource group.
-   * @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 options The options parameters.
-   */
-  listByResourceGroup(
-    resourceGroupName: string,
-    options?: ServicesListByResourceGroupOptionalParams,
-  ): PagedAsyncIterableIterator<SearchService>;
-  /**
-   * Gets a list of all Search services in the given subscription.
-   * @param options The options parameters.
-   */
-  listBySubscription(
-    options?: ServicesListBySubscriptionOptionalParams,
-  ): PagedAsyncIterableIterator<SearchService>;
-  /**
-   * 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.
-   * @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 AI Search service to create or update. Search service
-   *                          names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or
-   *                          last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in
-   *                          length. Search service names must be globally unique since they are part of the service URI
-   *                          (https://<name>.search.windows.net). You cannot change the service name after the service is
-   *                          created.
-   * @param service The definition of the search service to create or update.
-   * @param options The options parameters.
-   */
-  beginCreateOrUpdate(
-    resourceGroupName: string,
-    searchServiceName: string,
-    service: SearchService,
-    options?: ServicesCreateOrUpdateOptionalParams,
-  ): Promise<
-    SimplePollerLike<
-      OperationState<ServicesCreateOrUpdateResponse>,
-      ServicesCreateOrUpdateResponse
-    >
-  >;
-  /**
-   * 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.
-   * @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 AI Search service to create or update. Search service
-   *                          names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or
-   *                          last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in
-   *                          length. Search service names must be globally unique since they are part of the service URI
-   *                          (https://<name>.search.windows.net). You cannot change the service name after the service is
-   *                          created.
-   * @param service The definition of the search service to create or update.
-   * @param options The options parameters.
-   */
-  beginCreateOrUpdateAndWait(
-    resourceGroupName: string,
-    searchServiceName: string,
-    service: SearchService,
-    options?: ServicesCreateOrUpdateOptionalParams,
-  ): Promise<ServicesCreateOrUpdateResponse>;
-  /**
-   * Updates an existing search service in the given resource group.
-   * @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 AI Search service to update.
-   * @param service The definition of the search service to update.
-   * @param options The options parameters.
-   */
-  update(
-    resourceGroupName: string,
-    searchServiceName: string,
-    service: SearchServiceUpdate,
-    options?: ServicesUpdateOptionalParams,
-  ): Promise<ServicesUpdateResponse>;
-  /**
-   * Gets the search service with the given name in the given resource group.
-   * @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 AI Search service associated with the specified
-   *                          resource group.
-   * @param options The options parameters.
-   */
-  get(
-    resourceGroupName: string,
-    searchServiceName: string,
-    options?: ServicesGetOptionalParams,
-  ): Promise<ServicesGetResponse>;
-  /**
-   * Deletes a search service in the given resource group, along with its associated resources.
-   * @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 AI Search service associated with the specified
-   *                          resource group.
-   * @param options The options parameters.
-   */
-  delete(
-    resourceGroupName: string,
-    searchServiceName: string,
-    options?: ServicesDeleteOptionalParams,
-  ): Promise<void>;
-  /**
-   * 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://<name>.search.windows.net).
-   * @param name 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.
-   * @param options The options parameters.
-   */
-  checkNameAvailability(
-    name: string,
-    options?: ServicesCheckNameAvailabilityOptionalParams,
-  ): Promise<ServicesCheckNameAvailabilityResponse>;
-}

package/src/operationsInterfaces/sharedPrivateLinkResources.ts

@@ -1,131 +0,0 @@
-/*
- * 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 { SimplePollerLike, OperationState } from "@azure/core-lro";
-import {
-  SharedPrivateLinkResource,
-  SharedPrivateLinkResourcesListByServiceOptionalParams,
-  SharedPrivateLinkResourcesCreateOrUpdateOptionalParams,
-  SharedPrivateLinkResourcesCreateOrUpdateResponse,
-  SharedPrivateLinkResourcesGetOptionalParams,
-  SharedPrivateLinkResourcesGetResponse,
-  SharedPrivateLinkResourcesDeleteOptionalParams,
-} from "../models";
-
-/// <reference lib="esnext.asynciterable" />
-/** Interface representing a SharedPrivateLinkResources. */
-export interface SharedPrivateLinkResources {
-  /**
-   * Gets a list of all shared private link resources managed by the given 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 AI Search service associated with the specified
-   *                          resource group.
-   * @param options The options parameters.
-   */
-  listByService(
-    resourceGroupName: string,
-    searchServiceName: string,
-    options?: SharedPrivateLinkResourcesListByServiceOptionalParams,
-  ): PagedAsyncIterableIterator<SharedPrivateLinkResource>;
-  /**
-   * Initiates the creation or update of a shared private link resource managed by the search service in
-   * the given resource group.
-   * @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 AI Search service associated with the specified
-   *                          resource group.
-   * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
-   *                                      Azure AI Search service within the specified resource group.
-   * @param sharedPrivateLinkResource The definition of the shared private link resource to create or
-   *                                  update.
-   * @param options The options parameters.
-   */
-  beginCreateOrUpdate(
-    resourceGroupName: string,
-    searchServiceName: string,
-    sharedPrivateLinkResourceName: string,
-    sharedPrivateLinkResource: SharedPrivateLinkResource,
-    options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams,
-  ): Promise<
-    SimplePollerLike<
-      OperationState<SharedPrivateLinkResourcesCreateOrUpdateResponse>,
-      SharedPrivateLinkResourcesCreateOrUpdateResponse
-    >
-  >;
-  /**
-   * Initiates the creation or update of a shared private link resource managed by the search service in
-   * the given resource group.
-   * @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 AI Search service associated with the specified
-   *                          resource group.
-   * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
-   *                                      Azure AI Search service within the specified resource group.
-   * @param sharedPrivateLinkResource The definition of the shared private link resource to create or
-   *                                  update.
-   * @param options The options parameters.
-   */
-  beginCreateOrUpdateAndWait(
-    resourceGroupName: string,
-    searchServiceName: string,
-    sharedPrivateLinkResourceName: string,
-    sharedPrivateLinkResource: SharedPrivateLinkResource,
-    options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams,
-  ): Promise<SharedPrivateLinkResourcesCreateOrUpdateResponse>;
-  /**
-   * Gets the details of the shared private link resource managed by the search service in the given
-   * resource group.
-   * @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 AI Search service associated with the specified
-   *                          resource group.
-   * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
-   *                                      Azure AI Search service within the specified resource group.
-   * @param options The options parameters.
-   */
-  get(
-    resourceGroupName: string,
-    searchServiceName: string,
-    sharedPrivateLinkResourceName: string,
-    options?: SharedPrivateLinkResourcesGetOptionalParams,
-  ): Promise<SharedPrivateLinkResourcesGetResponse>;
-  /**
-   * Initiates the deletion of the shared private link resource from the 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 AI Search service associated with the specified
-   *                          resource group.
-   * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
-   *                                      Azure AI Search service within the specified resource group.
-   * @param options The options parameters.
-   */
-  beginDelete(
-    resourceGroupName: string,
-    searchServiceName: string,
-    sharedPrivateLinkResourceName: string,
-    options?: SharedPrivateLinkResourcesDeleteOptionalParams,
-  ): Promise<SimplePollerLike<OperationState<void>, void>>;
-  /**
-   * Initiates the deletion of the shared private link resource from the 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 AI Search service associated with the specified
-   *                          resource group.
-   * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
-   *                                      Azure AI Search service within the specified resource group.
-   * @param options The options parameters.
-   */
-  beginDeleteAndWait(
-    resourceGroupName: string,
-    searchServiceName: string,
-    sharedPrivateLinkResourceName: string,
-    options?: SharedPrivateLinkResourcesDeleteOptionalParams,
-  ): Promise<void>;
-}

package/src/operationsInterfaces/usages.ts

@@ -1,27 +0,0 @@
-/*
- * 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 {
-  QuotaUsageResult,
-  UsagesListBySubscriptionOptionalParams,
-} from "../models";
-
-/// <reference lib="esnext.asynciterable" />
-/** Interface representing a Usages. */
-export interface Usages {
-  /**
-   * Get a list of all Azure AI Search quota usages across the subscription.
-   * @param location The unique location name for a Microsoft Azure geographic region.
-   * @param options The options parameters.
-   */
-  listBySubscription(
-    location: string,
-    options?: UsagesListBySubscriptionOptionalParams,
-  ): PagedAsyncIterableIterator<QuotaUsageResult>;
-}

package/src/pagingHelper.ts

@@ -1,39 +0,0 @@
-/*
- * 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.
- */
-
-export interface PageInfo {
-  continuationToken?: string;
-}
-
-const pageMap = new WeakMap<object, PageInfo>();
-
-/**
- * Given the last `.value` produced by the `byPage` iterator,
- * returns a continuation token that can be used to begin paging from
- * that point later.
- * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
- * @returns The continuation token that can be passed into byPage() during future calls.
- */
-export function getContinuationToken(page: unknown): string | undefined {
-  if (typeof page !== "object" || page === null) {
-    return undefined;
-  }
-  return pageMap.get(page)?.continuationToken;
-}
-
-export function setContinuationToken(
-  page: unknown,
-  continuationToken: string | undefined,
-): void {
-  if (typeof page !== "object" || page === null || !continuationToken) {
-    return;
-  }
-  const pageInfo = pageMap.get(page) ?? {};
-  pageInfo.continuationToken = continuationToken;
-  pageMap.set(page, pageInfo);
-}

package/src/searchManagementClient.ts

@@ -1,226 +0,0 @@
-/*
- * 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 * as coreClient from "@azure/core-client";
-import * as coreRestPipeline from "@azure/core-rest-pipeline";
-import {
-  PipelineRequest,
-  PipelineResponse,
-  SendRequest,
-} from "@azure/core-rest-pipeline";
-import * as coreAuth from "@azure/core-auth";
-import {
-  OperationsImpl,
-  AdminKeysImpl,
-  QueryKeysImpl,
-  ServicesImpl,
-  PrivateLinkResourcesImpl,
-  PrivateEndpointConnectionsImpl,
-  SharedPrivateLinkResourcesImpl,
-  UsagesImpl,
-  NetworkSecurityPerimeterConfigurationsImpl,
-} from "./operations";
-import {
-  Operations,
-  AdminKeys,
-  QueryKeys,
-  Services,
-  PrivateLinkResources,
-  PrivateEndpointConnections,
-  SharedPrivateLinkResources,
-  Usages,
-  NetworkSecurityPerimeterConfigurations,
-} from "./operationsInterfaces";
-import * as Parameters from "./models/parameters";
-import * as Mappers from "./models/mappers";
-import {
-  SearchManagementClientOptionalParams,
-  UsageBySubscriptionSkuOptionalParams,
-  UsageBySubscriptionSkuResponse,
-} from "./models";
-
-export class SearchManagementClient extends coreClient.ServiceClient {
-  $host: string;
-  apiVersion: string;
-  subscriptionId: string;
-
-  /**
-   * Initializes a new instance of the SearchManagementClient class.
-   * @param credentials Subscription credentials which uniquely identify client subscription.
-   * @param subscriptionId The unique identifier for a Microsoft Azure subscription. You can obtain this
-   *                       value from the Azure Resource Manager API or the portal.
-   * @param options The parameter options
-   */
-  constructor(
-    credentials: coreAuth.TokenCredential,
-    subscriptionId: string,
-    options?: SearchManagementClientOptionalParams,
-  ) {
-    if (credentials === undefined) {
-      throw new Error("'credentials' cannot be null");
-    }
-    if (subscriptionId === undefined) {
-      throw new Error("'subscriptionId' cannot be null");
-    }
-
-    // Initializing default values for options
-    if (!options) {
-      options = {};
-    }
-    const defaults: SearchManagementClientOptionalParams = {
-      requestContentType: "application/json; charset=utf-8",
-      credential: credentials,
-    };
-
-    const packageDetails = `azsdk-js-arm-search/4.0.0-beta.1`;
-    const userAgentPrefix =
-      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
-        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
-        : `${packageDetails}`;
-
-    const optionsWithDefaults = {
-      ...defaults,
-      ...options,
-      userAgentOptions: {
-        userAgentPrefix,
-      },
-      endpoint:
-        options.endpoint ?? options.baseUri ?? "https://management.azure.com",
-    };
-    super(optionsWithDefaults);
-
-    let bearerTokenAuthenticationPolicyFound: boolean = false;
-    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
-      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] =
-        options.pipeline.getOrderedPolicies();
-      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
-        (pipelinePolicy) =>
-          pipelinePolicy.name ===
-          coreRestPipeline.bearerTokenAuthenticationPolicyName,
-      );
-    }
-    if (
-      !options ||
-      !options.pipeline ||
-      options.pipeline.getOrderedPolicies().length == 0 ||
-      !bearerTokenAuthenticationPolicyFound
-    ) {
-      this.pipeline.removePolicy({
-        name: coreRestPipeline.bearerTokenAuthenticationPolicyName,
-      });
-      this.pipeline.addPolicy(
-        coreRestPipeline.bearerTokenAuthenticationPolicy({
-          credential: credentials,
-          scopes:
-            optionsWithDefaults.credentialScopes ??
-            `${optionsWithDefaults.endpoint}/.default`,
-          challengeCallbacks: {
-            authorizeRequestOnChallenge:
-              coreClient.authorizeRequestOnClaimChallenge,
-          },
-        }),
-      );
-    }
-    // Parameter assignments
-    this.subscriptionId = subscriptionId;
-
-    // Assigning values to Constant parameters
-    this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2024-06-01-preview";
-    this.operations = new OperationsImpl(this);
-    this.adminKeys = new AdminKeysImpl(this);
-    this.queryKeys = new QueryKeysImpl(this);
-    this.services = new ServicesImpl(this);
-    this.privateLinkResources = new PrivateLinkResourcesImpl(this);
-    this.privateEndpointConnections = new PrivateEndpointConnectionsImpl(this);
-    this.sharedPrivateLinkResources = new SharedPrivateLinkResourcesImpl(this);
-    this.usages = new UsagesImpl(this);
-    this.networkSecurityPerimeterConfigurations =
-      new NetworkSecurityPerimeterConfigurationsImpl(this);
-    this.addCustomApiVersionPolicy(options.apiVersion);
-  }
-
-  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
-  private addCustomApiVersionPolicy(apiVersion?: string) {
-    if (!apiVersion) {
-      return;
-    }
-    const apiVersionPolicy = {
-      name: "CustomApiVersionPolicy",
-      async sendRequest(
-        request: PipelineRequest,
-        next: SendRequest,
-      ): Promise<PipelineResponse> {
-        const param = request.url.split("?");
-        if (param.length > 1) {
-          const newParams = param[1].split("&").map((item) => {
-            if (item.indexOf("api-version") > -1) {
-              return "api-version=" + apiVersion;
-            } else {
-              return item;
-            }
-          });
-          request.url = param[0] + "?" + newParams.join("&");
-        }
-        return next(request);
-      },
-    };
-    this.pipeline.addPolicy(apiVersionPolicy);
-  }
-
-  /**
-   * Gets the quota usage for a search sku in the given subscription.
-   * @param location The unique location name for a Microsoft Azure geographic region.
-   * @param skuName The unique SKU name that identifies a billable tier.
-   * @param options The options parameters.
-   */
-  usageBySubscriptionSku(
-    location: string,
-    skuName: string,
-    options?: UsageBySubscriptionSkuOptionalParams,
-  ): Promise<UsageBySubscriptionSkuResponse> {
-    return this.sendOperationRequest(
-      { location, skuName, options },
-      usageBySubscriptionSkuOperationSpec,
-    );
-  }
-
-  operations: Operations;
-  adminKeys: AdminKeys;
-  queryKeys: QueryKeys;
-  services: Services;
-  privateLinkResources: PrivateLinkResources;
-  privateEndpointConnections: PrivateEndpointConnections;
-  sharedPrivateLinkResources: SharedPrivateLinkResources;
-  usages: Usages;
-  networkSecurityPerimeterConfigurations: NetworkSecurityPerimeterConfigurations;
-}
-// Operation Specifications
-const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
-
-const usageBySubscriptionSkuOperationSpec: coreClient.OperationSpec = {
-  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}",
-  httpMethod: "GET",
-  responses: {
-    200: {
-      bodyMapper: Mappers.QuotaUsageResult,
-    },
-    default: {
-      bodyMapper: Mappers.CloudError,
-    },
-  },
-  queryParameters: [Parameters.apiVersion],
-  urlParameters: [
-    Parameters.$host,
-    Parameters.subscriptionId,
-    Parameters.location,
-    Parameters.skuName,
-  ],
-  headerParameters: [Parameters.accept, Parameters.clientRequestId],
-  serializer,
-};

package/tsconfig.json

@@ -1,33 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "es6",
-    "moduleResolution": "node",
-    "strict": true,
-    "target": "es6",
-    "sourceMap": true,
-    "declarationMap": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "lib": [
-      "es6",
-      "dom"
-    ],
-    "declaration": true,
-    "outDir": "./dist-esm",
-    "importHelpers": true,
-    "paths": {
-      "@azure/arm-search": [
-        "./src/index"
-      ]
-    }
-  },
-  "include": [
-    "./src/**/*.ts",
-    "./test/**/*.ts",
-    "samples-dev/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}