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

package/package.json

@@ -3,15 +3,15 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for AdvisorManagementClient.",
-  "version": "3.0.4-alpha.20221026.1",
+  "version": "3.1.0",
   "engines": {
     "node": ">=14.0.0"
   },
   "dependencies": {
     "@azure/core-paging": "^1.2.0",
-    "@azure/core-client": "^1.0.0",
+    "@azure/core-client": "^1.6.1",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-rest-pipeline": "^1.1.0",
+    "@azure/core-rest-pipeline": "^1.8.0",
     "tslib": "^2.2.0"
   },
   "keywords": [
@@ -34,13 +34,18 @@
     "mkdirp": "^1.0.4",
     "rollup": "^2.66.1",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "typescript": "~4.2.0",
+    "typescript": "~4.8.0",
     "uglify-js": "^3.4.9",
     "rimraf": "^3.0.0",
     "@azure/identity": "^2.0.1",
-    "@azure-tools/test-recorder": "^1.0.0",
+    "@azure-tools/test-recorder": "^2.0.0",
+    "@azure-tools/test-credential": "^1.0.0",
     "mocha": "^7.1.1",
-    "cross-env": "^7.0.2"
+    "@types/chai": "^4.2.8",
+    "chai": "^4.2.0",
+    "cross-env": "^7.0.2",
+    "@types/node": "^14.0.0",
+    "@azure/dev-tool": "^1.0.0"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/advisor/arm-advisor",
   "repository": {
@@ -91,9 +96,8 @@
     "unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
     "unit-test:browser": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
-    "integration-test:browser": "echo skipped",
-    "docs": "echo skipped"
+    "integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
+    "integration-test:browser": "echo skipped"
   },
   "sideEffects": false,
   "//metadata": {
@@ -113,4 +117,4 @@
     "disableDocsMs": true,
     "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-advisor?view=azure-node-preview"
   }
-}
+}

package/review/arm-advisor.api.md

@@ -51,11 +51,11 @@ export interface ARMErrorResponseBody {
 export type Category = string;
 
 // @public
-export type ConfigData = Resource & {
+export interface ConfigData extends Resource {
+    digests?: DigestConfig[];
     exclude?: boolean;
     lowCpuThreshold?: CpuThreshold;
-    digests?: DigestConfig[];
-};
+}
 
 // @public
 export interface ConfigurationListResult {
@@ -125,72 +125,56 @@ export interface DigestConfig {
 // @public
 export type DigestConfigState = string;
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public
 export type Impact = string;
 
 // @public
 export enum KnownCategory {
-    // (undocumented)
     Cost = "Cost",
-    // (undocumented)
     HighAvailability = "HighAvailability",
-    // (undocumented)
     OperationalExcellence = "OperationalExcellence",
-    // (undocumented)
     Performance = "Performance",
-    // (undocumented)
     Security = "Security"
 }
 
 // @public
 export enum KnownConfigurationName {
-    // (undocumented)
     Default = "default"
 }
 
 // @public
 export enum KnownCpuThreshold {
-    // (undocumented)
     Fifteen = "15",
-    // (undocumented)
     Five = "5",
-    // (undocumented)
     Ten = "10",
-    // (undocumented)
     Twenty = "20"
 }
 
 // @public
 export enum KnownDigestConfigState {
-    // (undocumented)
     Active = "Active",
-    // (undocumented)
     Disabled = "Disabled"
 }
 
 // @public
 export enum KnownImpact {
-    // (undocumented)
     High = "High",
-    // (undocumented)
     Low = "Low",
-    // (undocumented)
     Medium = "Medium"
 }
 
 // @public
 export enum KnownRisk {
-    // (undocumented)
     Error = "Error",
-    // (undocumented)
     None = "None",
-    // (undocumented)
     Warning = "Warning"
 }
 
 // @public
 export enum KnownScenario {
-    // (undocumented)
     Alerts = "Alerts"
 }
 
@@ -354,37 +338,37 @@ export interface ResourceMetadata {
 }
 
 // @public
-export type ResourceRecommendationBase = Resource & {
+export interface ResourceRecommendationBase extends Resource {
+    actions?: {
+        [propertyName: string]: Record<string, unknown>;
+    }[];
     category?: Category;
-    impact?: Impact;
-    impactedField?: string;
-    impactedValue?: string;
-    lastUpdated?: Date;
-    metadata?: {
+    description?: string;
+    exposedMetadataProperties?: {
         [propertyName: string]: Record<string, unknown>;
     };
-    recommendationTypeId?: string;
-    risk?: Risk;
-    shortDescription?: ShortDescription;
-    suppressionIds?: string[];
     extendedProperties?: {
         [propertyName: string]: string;
     };
-    resourceMetadata?: ResourceMetadata;
-    description?: string;
+    impact?: Impact;
+    impactedField?: string;
+    impactedValue?: string;
     label?: string;
+    lastUpdated?: Date;
     learnMoreLink?: string;
-    potentialBenefits?: string;
-    actions?: {
-        [propertyName: string]: Record<string, unknown>;
-    }[];
-    remediation?: {
+    metadata?: {
         [propertyName: string]: Record<string, unknown>;
     };
-    exposedMetadataProperties?: {
+    potentialBenefits?: string;
+    recommendationTypeId?: string;
+    remediation?: {
         [propertyName: string]: Record<string, unknown>;
     };
-};
+    resourceMetadata?: ResourceMetadata;
+    risk?: Risk;
+    shortDescription?: ShortDescription;
+    suppressionIds?: string[];
+}
 
 // @public
 export interface ResourceRecommendationBaseListResult {
@@ -405,11 +389,11 @@ export interface ShortDescription {
 }
 
 // @public
-export type SuppressionContract = Resource & {
+export interface SuppressionContract extends Resource {
+    readonly expirationTimeStamp?: Date;
     suppressionId?: string;
     ttl?: string;
-    readonly expirationTimeStamp?: Date;
-};
+}
 
 // @public
 export interface SuppressionContractListResult {

package/src/advisorManagementClient.ts

@@ -7,6 +7,12 @@
  */
 
 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 {
   RecommendationMetadataImpl,
@@ -56,26 +62,54 @@ export class AdvisorManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-advisor/3.0.4`;
+    const packageDetails = `azsdk-js-arm-advisor/3.1.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);
+
+    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;
 
@@ -87,6 +121,35 @@ export class AdvisorManagementClient extends coreClient.ServiceClient {
     this.recommendations = new RecommendationsImpl(this);
     this.operations = new OperationsImpl(this);
     this.suppressions = new SuppressionsImpl(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);
   }
 
   recommendationMetadata: RecommendationMetadata;

package/src/index.ts

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

package/src/models/index.ts

@@ -165,17 +165,17 @@ export interface SuppressionContractListResult {
 }
 
 /** The Advisor configuration data structure. */
-export type ConfigData = Resource & {
+export 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[];
-};
+}
 
 /** Advisor Recommendation. */
-export type ResourceRecommendationBase = Resource & {
+export interface ResourceRecommendationBase extends Resource {
   /** The category of the recommendation. */
   category?: Category;
   /** The business impact of the recommendation. */
@@ -216,10 +216,10 @@ export type ResourceRecommendationBase = Resource & {
   exposedMetadataProperties?: {
     [propertyName: string]: Record<string, unknown>;
   };
-};
+}
 
 /** The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule. */
-export type SuppressionContract = Resource & {
+export interface SuppressionContract extends Resource {
   /** The GUID of the suppression. */
   suppressionId?: string;
   /** The duration for which the suppression is valid. */
@@ -229,7 +229,7 @@ export type SuppressionContract = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly expirationTimeStamp?: Date;
-};
+}
 
 /** Defines headers for Recommendations_generate operation. */
 export interface RecommendationsGenerateHeaders {
@@ -241,6 +241,7 @@ export interface RecommendationsGenerateHeaders {
 
 /** Known values of {@link Scenario} that the service accepts. */
 export enum KnownScenario {
+  /** Alerts */
   Alerts = "Alerts"
 }
 
@@ -255,9 +256,13 @@ export type Scenario = string;
 
 /** Known values of {@link CpuThreshold} that the service accepts. */
 export enum KnownCpuThreshold {
+  /** Five */
   Five = "5",
+  /** Ten */
   Ten = "10",
+  /** Fifteen */
   Fifteen = "15",
+  /** Twenty */
   Twenty = "20"
 }
 
@@ -275,10 +280,15 @@ export type CpuThreshold = string;
 
 /** Known values of {@link Category} that the service accepts. */
 export enum KnownCategory {
+  /** HighAvailability */
   HighAvailability = "HighAvailability",
+  /** Security */
   Security = "Security",
+  /** Performance */
   Performance = "Performance",
+  /** Cost */
   Cost = "Cost",
+  /** OperationalExcellence */
   OperationalExcellence = "OperationalExcellence"
 }
 
@@ -297,7 +307,9 @@ export type Category = string;
 
 /** Known values of {@link DigestConfigState} that the service accepts. */
 export enum KnownDigestConfigState {
+  /** Active */
   Active = "Active",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -313,6 +325,7 @@ export type DigestConfigState = string;
 
 /** Known values of {@link ConfigurationName} that the service accepts. */
 export enum KnownConfigurationName {
+  /** Default */
   Default = "default"
 }
 
@@ -327,8 +340,11 @@ export type ConfigurationName = string;
 
 /** Known values of {@link Impact} that the service accepts. */
 export enum KnownImpact {
+  /** High */
   High = "High",
+  /** Medium */
   Medium = "Medium",
+  /** Low */
   Low = "Low"
 }
 
@@ -345,8 +361,11 @@ export type Impact = string;
 
 /** Known values of {@link Risk} that the service accepts. */
 export enum KnownRisk {
+  /** Error */
   Error = "Error",
+  /** Warning */
   Warning = "Warning",
+  /** None */
   None = "None"
 }
 

package/src/operations/configurations.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 { Configurations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,12 +17,12 @@ import {
   ConfigData,
   ConfigurationsListBySubscriptionNextOptionalParams,
   ConfigurationsListBySubscriptionOptionalParams,
-  ConfigurationsListByResourceGroupOptionalParams,
   ConfigurationsListBySubscriptionResponse,
+  ConfigurationsListByResourceGroupOptionalParams,
+  ConfigurationsListByResourceGroupResponse,
   ConfigurationName,
   ConfigurationsCreateInSubscriptionOptionalParams,
   ConfigurationsCreateInSubscriptionResponse,
-  ConfigurationsListByResourceGroupResponse,
   ConfigurationsCreateInResourceGroupOptionalParams,
   ConfigurationsCreateInResourceGroupResponse,
   ConfigurationsListBySubscriptionNextResponse
@@ -55,22 +56,34 @@ export class ConfigurationsImpl implements Configurations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listBySubscriptionPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listBySubscriptionPagingPage(options, settings);
       }
     };
   }
 
   private async *listBySubscriptionPagingPage(
-    options?: ConfigurationsListBySubscriptionOptionalParams
+    options?: ConfigurationsListBySubscriptionOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ConfigData[]> {
-    let result = await this._listBySubscription(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ConfigurationsListBySubscriptionResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listBySubscription(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listBySubscriptionNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -99,17 +112,26 @@ export class ConfigurationsImpl implements Configurations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listByResourceGroupPagingPage(resourceGroup, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listByResourceGroupPagingPage(
+          resourceGroup,
+          options,
+          settings
+        );
       }
     };
   }
 
   private async *listByResourceGroupPagingPage(
     resourceGroup: string,
-    options?: ConfigurationsListByResourceGroupOptionalParams
+    options?: ConfigurationsListByResourceGroupOptionalParams,
+    _settings?: PageSettings
   ): AsyncIterableIterator<ConfigData[]> {
-    let result = await this._listByResourceGroup(resourceGroup, options);
+    let result: ConfigurationsListByResourceGroupResponse;
+    result = await this._listByResourceGroup(resourceGroup, options);
     yield result.value || [];
   }
 

package/src/operations/operations.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 { Operations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -48,22 +49,34 @@ export class OperationsImpl implements Operations {
       [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?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<OperationEntity[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: OperationsListResponse;
+    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/recommendationMetadata.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 { RecommendationMetadata } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,9 +17,9 @@ import {
   MetadataEntity,
   RecommendationMetadataListNextOptionalParams,
   RecommendationMetadataListOptionalParams,
+  RecommendationMetadataListResponse,
   RecommendationMetadataGetOptionalParams,
   RecommendationMetadataGetResponse,
-  RecommendationMetadataListResponse,
   RecommendationMetadataListNextResponse
 } from "../models";
 
@@ -50,22 +51,34 @@ export class RecommendationMetadataImpl implements RecommendationMetadata {
       [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?: RecommendationMetadataListOptionalParams
+    options?: RecommendationMetadataListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<MetadataEntity[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: RecommendationMetadataListResponse;
+    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;
     }
   }