@azure/arm-reservations 7.2.1-alpha.20230202.1 → 8.0.0-alpha.20230210.2

package/src/azureReservationAPI.ts

@@ -9,6 +9,8 @@
 import * as coreClient from "@azure/core-client";
 import * as coreRestPipeline from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "./pagingHelper";
 import {
   ReservationImpl,
   ReservationOrderImpl,
@@ -35,12 +37,16 @@ import * as Parameters from "./models/parameters";
 import * as Mappers from "./models/mappers";
 import {
   AzureReservationAPIOptionalParams,
+  Catalog,
+  GetCatalogNextOptionalParams,
   GetCatalogOptionalParams,
   GetCatalogResponse,
   GetAppliedReservationListOptionalParams,
-  GetAppliedReservationListResponse
+  GetAppliedReservationListResponse,
+  GetCatalogNextResponse
 } from "./models";
 
+/// <reference lib="esnext.asynciterable" />
 export class AzureReservationAPI extends coreClient.ServiceClient {
   $host: string;
 
@@ -66,22 +72,19 @@ export class AzureReservationAPI extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-reservations/7.2.1`;
+    const packageDetails = `azsdk-js-arm-reservations/8.0.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
         : `${packageDetails}`;
 
-    if (!options.credentialScopes) {
-      options.credentialScopes = ["https://management.azure.com/.default"];
-    }
     const optionsWithDefaults = {
       ...defaults,
       ...options,
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
@@ -107,7 +110,9 @@ export class AzureReservationAPI extends coreClient.ServiceClient {
       this.pipeline.addPolicy(
         coreRestPipeline.bearerTokenAuthenticationPolicy({
           credential: credentials,
-          scopes: `${optionsWithDefaults.credentialScopes}`,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
           challengeCallbacks: {
             authorizeRequestOnChallenge:
               coreClient.authorizeRequestOnClaimChallenge
@@ -134,7 +139,72 @@ export class AzureReservationAPI extends coreClient.ServiceClient {
    * @param subscriptionId Id of the subscription
    * @param options The options parameters.
    */
-  getCatalog(
+  public listCatalog(
+    subscriptionId: string,
+    options?: GetCatalogOptionalParams
+  ): PagedAsyncIterableIterator<Catalog> {
+    const iter = this.getCatalogPagingAll(subscriptionId, options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.getCatalogPagingPage(subscriptionId, options, settings);
+      }
+    };
+  }
+
+  private async *getCatalogPagingPage(
+    subscriptionId: string,
+    options?: GetCatalogOptionalParams,
+    settings?: PageSettings
+  ): AsyncIterableIterator<Catalog[]> {
+    let result: GetCatalogResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._getCatalog(subscriptionId, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+    while (continuationToken) {
+      result = await this._getCatalogNext(
+        subscriptionId,
+        continuationToken,
+        options
+      );
+      continuationToken = result.nextLink;
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+  }
+
+  private async *getCatalogPagingAll(
+    subscriptionId: string,
+    options?: GetCatalogOptionalParams
+  ): AsyncIterableIterator<Catalog> {
+    for await (const page of this.getCatalogPagingPage(
+      subscriptionId,
+      options
+    )) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Get the regions and skus that are available for RI purchase for the specified Azure subscription.
+   * @param subscriptionId Id of the subscription
+   * @param options The options parameters.
+   */
+  private _getCatalog(
     subscriptionId: string,
     options?: GetCatalogOptionalParams
   ): Promise<GetCatalogResponse> {
@@ -160,6 +230,23 @@ export class AzureReservationAPI extends coreClient.ServiceClient {
     );
   }
 
+  /**
+   * GetCatalogNext
+   * @param subscriptionId Id of the subscription
+   * @param nextLink The nextLink from the previous successful call to the GetCatalog method.
+   * @param options The options parameters.
+   */
+  private _getCatalogNext(
+    subscriptionId: string,
+    nextLink: string,
+    options?: GetCatalogNextOptionalParams
+  ): Promise<GetCatalogNextResponse> {
+    return this.sendOperationRequest(
+      { subscriptionId, nextLink, options },
+      getCatalogNextOperationSpec
+    );
+  }
+
   reservation: Reservation;
   reservationOrder: ReservationOrder;
   operation: Operation;
@@ -178,12 +265,7 @@ const getCatalogOperationSpec: coreClient.OperationSpec = {
   httpMethod: "GET",
   responses: {
     200: {
-      bodyMapper: {
-        type: {
-          name: "Sequence",
-          element: { type: { name: "Composite", className: "Catalog" } }
-        }
-      }
+      bodyMapper: Mappers.CatalogsResult
     },
     default: {
       bodyMapper: Mappers.ErrorModel
@@ -191,11 +273,14 @@ const getCatalogOperationSpec: coreClient.OperationSpec = {
   },
   queryParameters: [
     Parameters.apiVersion,
+    Parameters.filter,
     Parameters.reservedResourceType,
     Parameters.location,
     Parameters.publisherId,
     Parameters.offerId,
-    Parameters.planId
+    Parameters.planId,
+    Parameters.skip,
+    Parameters.take1
   ],
   urlParameters: [Parameters.$host, Parameters.subscriptionId],
   headerParameters: [Parameters.accept],
@@ -218,3 +303,22 @@ const getAppliedReservationListOperationSpec: coreClient.OperationSpec = {
   headerParameters: [Parameters.accept],
   serializer
 };
+const getCatalogNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CatalogsResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorModel
+    }
+  },
+  urlParameters: [
+    Parameters.$host,
+    Parameters.nextLink,
+    Parameters.subscriptionId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { AzureReservationAPI } from "./azureReservationAPI";
 export * from "./operationsInterfaces";