@azure/arm-advisor 3.0.4-alpha.20221026.1 → 3.1.0

package/src/operations/recommendations.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { Recommendations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,10 +17,10 @@ import {
   ResourceRecommendationBase,
   RecommendationsListNextOptionalParams,
   RecommendationsListOptionalParams,
+  RecommendationsListResponse,
   RecommendationsGenerateOptionalParams,
   RecommendationsGenerateResponse,
   RecommendationsGetGenerateStatusOptionalParams,
-  RecommendationsListResponse,
   RecommendationsGetOptionalParams,
   RecommendationsGetResponse,
   RecommendationsListNextResponse
@@ -54,22 +55,34 @@ export class RecommendationsImpl implements Recommendations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(options, settings);
       }
     };
   }
 
   private async *listPagingPage(
-    options?: RecommendationsListOptionalParams
+    options?: RecommendationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ResourceRecommendationBase[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: RecommendationsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/suppressions.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { Suppressions } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,12 +17,12 @@ import {
   SuppressionContract,
   SuppressionsListNextOptionalParams,
   SuppressionsListOptionalParams,
+  SuppressionsListResponse,
   SuppressionsGetOptionalParams,
   SuppressionsGetResponse,
   SuppressionsCreateOptionalParams,
   SuppressionsCreateResponse,
   SuppressionsDeleteOptionalParams,
-  SuppressionsListResponse,
   SuppressionsListNextResponse
 } from "../models";
 
@@ -54,22 +55,34 @@ export class SuppressionsImpl implements Suppressions {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(options, settings);
       }
     };
   }
 
   private async *listPagingPage(
-    options?: SuppressionsListOptionalParams
+    options?: SuppressionsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<SuppressionContract[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: SuppressionsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+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/types/arm-advisor.d.ts

@@ -13,6 +13,8 @@ export declare class AdvisorManagementClient extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AdvisorManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     recommendationMetadata: RecommendationMetadata;
     configurations: Configurations;
     recommendations: Recommendations;
@@ -57,14 +59,14 @@ export declare interface ARMErrorResponseBody {
 export declare type Category = string;
 
 /** The Advisor configuration data structure. */
-export declare type ConfigData = Resource & {
+export declare interface ConfigData extends Resource {
     /** Exclude the resource from Advisor evaluations. Valid values: False (default) or True. */
     exclude?: boolean;
     /** Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. */
     lowCpuThreshold?: CpuThreshold;
     /** Advisor digest configuration. Valid only for subscriptions */
     digests?: DigestConfig[];
-};
+}
 
 /** The list of Advisor configurations. */
 export declare interface ConfigurationListResult {
@@ -187,6 +189,15 @@ export declare interface DigestConfig {
  */
 export declare type DigestConfigState = string;
 
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
 /**
  * Defines values for Impact. \
  * {@link KnownImpact} can be used interchangeably with Impact,
@@ -200,48 +211,67 @@ export declare type Impact = string;
 
 /** Known values of {@link Category} that the service accepts. */
 export declare enum KnownCategory {
+    /** HighAvailability */
     HighAvailability = "HighAvailability",
+    /** Security */
     Security = "Security",
+    /** Performance */
     Performance = "Performance",
+    /** Cost */
     Cost = "Cost",
+    /** OperationalExcellence */
     OperationalExcellence = "OperationalExcellence"
 }
 
 /** Known values of {@link ConfigurationName} that the service accepts. */
 export declare enum KnownConfigurationName {
+    /** Default */
     Default = "default"
 }
 
 /** Known values of {@link CpuThreshold} that the service accepts. */
 export declare enum KnownCpuThreshold {
+    /** Five */
     Five = "5",
+    /** Ten */
     Ten = "10",
+    /** Fifteen */
     Fifteen = "15",
+    /** Twenty */
     Twenty = "20"
 }
 
 /** Known values of {@link DigestConfigState} that the service accepts. */
 export declare enum KnownDigestConfigState {
+    /** Active */
     Active = "Active",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link Impact} that the service accepts. */
 export declare enum KnownImpact {
+    /** High */
     High = "High",
+    /** Medium */
     Medium = "Medium",
+    /** Low */
     Low = "Low"
 }
 
 /** Known values of {@link Risk} that the service accepts. */
 export declare enum KnownRisk {
+    /** Error */
     Error = "Error",
+    /** Warning */
     Warning = "Warning",
+    /** None */
     None = "None"
 }
 
 /** Known values of {@link Scenario} that the service accepts. */
 export declare enum KnownScenario {
+    /** Alerts */
     Alerts = "Alerts"
 }
 
@@ -487,7 +517,7 @@ export declare interface ResourceMetadata {
 }
 
 /** Advisor Recommendation. */
-export declare type ResourceRecommendationBase = Resource & {
+export declare interface ResourceRecommendationBase extends Resource {
     /** The category of the recommendation. */
     category?: Category;
     /** The business impact of the recommendation. */
@@ -536,7 +566,7 @@ export declare type ResourceRecommendationBase = Resource & {
     exposedMetadataProperties?: {
         [propertyName: string]: Record<string, unknown>;
     };
-};
+}
 
 /** The list of Advisor recommendations. */
 export declare interface ResourceRecommendationBaseListResult {
@@ -575,7 +605,7 @@ export declare interface ShortDescription {
 }
 
 /** The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule. */
-export declare type SuppressionContract = Resource & {
+export declare interface SuppressionContract extends Resource {
     /** The GUID of the suppression. */
     suppressionId?: string;
     /** The duration for which the suppression is valid. */
@@ -585,7 +615,7 @@ export declare type SuppressionContract = Resource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly expirationTimeStamp?: Date;
-};
+}
 
 /** The list of Advisor suppressions. */
 export declare interface SuppressionContractListResult {

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.31.2"
+      "packageVersion": "7.33.5"
     }
   ]
 }