@azure/arm-commitmentplans 2.0.0-alpha.20221101.2 → 2.0.0-alpha.20221202.3

package/src/azureMLCommitmentPlansManagementClient.ts

@@ -8,6 +8,11 @@
 
 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,
@@ -63,41 +68,47 @@ export class AzureMLCommitmentPlansManagementClient extends coreClient.ServiceCl
         ? `${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();
-      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
           coreRestPipeline.bearerTokenAuthenticationPolicyName
       );
-      if (!bearerTokenAuthenticationPolicyFound) {
-        this.pipeline.removePolicy({
-          name: coreRestPipeline.bearerTokenAuthenticationPolicyName
-        });
-        this.pipeline.addPolicy(
-          coreRestPipeline.bearerTokenAuthenticationPolicy({
-            scopes: `${optionsWithDefaults.baseUri}/.default`,
-            challengeCallbacks: {
-              authorizeRequestOnChallenge:
-                coreClient.authorizeRequestOnClaimChallenge
-            }
-          })
-        );
-      }
+    }
+    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;
@@ -110,6 +121,35 @@ export class AzureMLCommitmentPlansManagementClient extends coreClient.ServiceCl
     this.commitmentAssociations = new CommitmentAssociationsImpl(this);
     this.commitmentPlans = new CommitmentPlansImpl(this);
     this.usageHistory = new UsageHistoryImpl(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);
   }
 
   operations: Operations;

package/src/index.ts

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

package/src/models/index.ts

@@ -365,15 +365,15 @@ export interface PlanUsageHistory {
 }
 
 /** Represents the association between a commitment plan and some other resource, such as a Machine Learning web service. */
-export type CommitmentAssociation = Resource & {
+export interface CommitmentAssociation extends Resource {
   /** An entity tag used to enforce optimistic concurrency. */
   etag?: string;
   /** The properties of the commitment association resource. */
   properties?: CommitmentAssociationProperties;
-};
+}
 
 /** An Azure ML commitment plan resource. */
-export type CommitmentPlan = Resource & {
+export interface CommitmentPlan extends Resource {
   /** An entity tag used to enforce optimistic concurrency. */
   etag?: string;
   /**
@@ -383,12 +383,15 @@ export type CommitmentPlan = Resource & {
   readonly properties?: CommitmentPlanProperties;
   /** The commitment plan SKU. */
   sku?: ResourceSku;
-};
+}
 
 /** Known values of {@link SkuCapacityScaleType} that the service accepts. */
 export enum KnownSkuCapacityScaleType {
+  /** Automatic */
   Automatic = "Automatic",
+  /** Manual */
   Manual = "Manual",
+  /** None */
   None = "None"
 }
 
@@ -405,7 +408,9 @@ export type SkuCapacityScaleType = string;
 
 /** Known values of {@link ResourceSkuRestrictionsType} that the service accepts. */
 export enum KnownResourceSkuRestrictionsType {
+  /** Location */
   Location = "location",
+  /** Zone */
   Zone = "zone"
 }
 
@@ -421,7 +426,9 @@ export type ResourceSkuRestrictionsType = string;
 
 /** Known values of {@link ResourceSkuRestrictionsReasonCode} that the service accepts. */
 export enum KnownResourceSkuRestrictionsReasonCode {
+  /** QuotaId */
   QuotaId = "QuotaId",
+  /** NotAvailableForSubscription */
   NotAvailableForSubscription = "NotAvailableForSubscription"
 }
 

package/src/operations/commitmentAssociations.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 { CommitmentAssociations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,9 +17,9 @@ import {
   CommitmentAssociation,
   CommitmentAssociationsListNextOptionalParams,
   CommitmentAssociationsListOptionalParams,
+  CommitmentAssociationsListResponse,
   CommitmentAssociationsGetOptionalParams,
   CommitmentAssociationsGetResponse,
-  CommitmentAssociationsListResponse,
   MoveCommitmentAssociationRequest,
   CommitmentAssociationsMoveOptionalParams,
   CommitmentAssociationsMoveResponse,
@@ -61,11 +62,15 @@ export class CommitmentAssociationsImpl implements CommitmentAssociations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listPagingPage(
           resourceGroupName,
           commitmentPlanName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -74,15 +79,18 @@ export class CommitmentAssociationsImpl implements CommitmentAssociations {
   private async *listPagingPage(
     resourceGroupName: string,
     commitmentPlanName: string,
-    options?: CommitmentAssociationsListOptionalParams
+    options?: CommitmentAssociationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<CommitmentAssociation[]> {
-    let result = await this._list(
-      resourceGroupName,
-      commitmentPlanName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: CommitmentAssociationsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, commitmentPlanName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         resourceGroupName,
@@ -91,7 +99,9 @@ export class CommitmentAssociationsImpl implements CommitmentAssociations {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/commitmentPlans.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 { CommitmentPlans } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,8 +17,10 @@ import {
   CommitmentPlan,
   CommitmentPlansListNextOptionalParams,
   CommitmentPlansListOptionalParams,
+  CommitmentPlansListResponse,
   CommitmentPlansListInResourceGroupNextOptionalParams,
   CommitmentPlansListInResourceGroupOptionalParams,
+  CommitmentPlansListInResourceGroupResponse,
   CommitmentPlansGetOptionalParams,
   CommitmentPlansGetResponse,
   CommitmentPlansCreateOrUpdateOptionalParams,
@@ -26,8 +29,6 @@ import {
   CommitmentPlanPatchPayload,
   CommitmentPlansPatchOptionalParams,
   CommitmentPlansPatchResponse,
-  CommitmentPlansListResponse,
-  CommitmentPlansListInResourceGroupResponse,
   CommitmentPlansListNextResponse,
   CommitmentPlansListInResourceGroupNextResponse
 } from "../models";
@@ -60,22 +61,34 @@ export class CommitmentPlansImpl implements CommitmentPlans {
       [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?: CommitmentPlansListOptionalParams
+    options?: CommitmentPlansListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<CommitmentPlan[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: CommitmentPlansListResponse;
+    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;
     }
   }
 
@@ -104,19 +117,33 @@ export class CommitmentPlansImpl implements CommitmentPlans {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listInResourceGroupPagingPage(resourceGroupName, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listInResourceGroupPagingPage(
+          resourceGroupName,
+          options,
+          settings
+        );
       }
     };
   }
 
   private async *listInResourceGroupPagingPage(
     resourceGroupName: string,
-    options?: CommitmentPlansListInResourceGroupOptionalParams
+    options?: CommitmentPlansListInResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<CommitmentPlan[]> {
-    let result = await this._listInResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: CommitmentPlansListInResourceGroupResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listInResourceGroup(resourceGroupName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listInResourceGroupNext(
         resourceGroupName,
@@ -124,7 +151,9 @@ export class CommitmentPlansImpl implements CommitmentPlans {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/operations.ts

@@ -6,7 +6,7 @@
  * 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 { Operations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -46,16 +46,21 @@ 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);
+    let result: OperationsListResponse;
+    result = await this._list(options);
     yield result.value || [];
   }
 

package/src/operations/skus.ts

@@ -6,7 +6,7 @@
  * 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 { Skus } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -46,16 +46,21 @@ export class SkusImpl implements Skus {
       [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?: SkusListOptionalParams
+    options?: SkusListOptionalParams,
+    _settings?: PageSettings
   ): AsyncIterableIterator<CatalogSku[]> {
-    let result = await this._list(options);
+    let result: SkusListResponse;
+    result = await this._list(options);
     yield result.value || [];
   }
 

package/src/operations/usageHistory.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 { UsageHistory } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -56,11 +57,15 @@ export class UsageHistoryImpl implements UsageHistory {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listPagingPage(
           resourceGroupName,
           commitmentPlanName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -69,15 +74,18 @@ export class UsageHistoryImpl implements UsageHistory {
   private async *listPagingPage(
     resourceGroupName: string,
     commitmentPlanName: string,
-    options?: UsageHistoryListOptionalParams
+    options?: UsageHistoryListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<PlanUsageHistory[]> {
-    let result = await this._list(
-      resourceGroupName,
-      commitmentPlanName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: UsageHistoryListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, commitmentPlanName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         resourceGroupName,
@@ -86,7 +94,9 @@ export class UsageHistoryImpl implements UsageHistory {
         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-commitmentplans.d.ts

@@ -13,6 +13,8 @@ export declare class AzureMLCommitmentPlansManagementClient extends coreClient.S
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMLCommitmentPlansManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     operations: Operations;
     skus: Skus;
     commitmentAssociations: CommitmentAssociations;
@@ -75,12 +77,12 @@ export declare interface CatalogSku {
 }
 
 /** Represents the association between a commitment plan and some other resource, such as a Machine Learning web service. */
-export declare type CommitmentAssociation = Resource & {
+export declare interface CommitmentAssociation extends Resource {
     /** An entity tag used to enforce optimistic concurrency. */
     etag?: string;
     /** The properties of the commitment association resource. */
     properties?: CommitmentAssociationProperties;
-};
+}
 
 /** A page of commitment association resources. */
 export declare interface CommitmentAssociationListResult {
@@ -170,7 +172,7 @@ export declare interface CommitmentAssociationsMoveOptionalParams extends coreCl
 export declare type CommitmentAssociationsMoveResponse = CommitmentAssociation;
 
 /** An Azure ML commitment plan resource. */
-export declare type CommitmentPlan = Resource & {
+export declare interface CommitmentPlan extends Resource {
     /** An entity tag used to enforce optimistic concurrency. */
     etag?: string;
     /**
@@ -180,7 +182,7 @@ export declare type CommitmentPlan = Resource & {
     readonly properties?: CommitmentPlanProperties;
     /** The commitment plan SKU. */
     sku?: ResourceSku;
-};
+}
 
 /** A page of commitment plan resources. */
 export declare interface CommitmentPlanListResult {
@@ -363,22 +365,38 @@ export declare type CommitmentPlansPatchResponse = CommitmentPlan;
 export declare interface CommitmentPlansRemoveOptionalParams extends coreClient.OperationOptions {
 }
 
+/**
+ * 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;
+
 /** Known values of {@link ResourceSkuRestrictionsReasonCode} that the service accepts. */
 export declare enum KnownResourceSkuRestrictionsReasonCode {
+    /** QuotaId */
     QuotaId = "QuotaId",
+    /** NotAvailableForSubscription */
     NotAvailableForSubscription = "NotAvailableForSubscription"
 }
 
 /** Known values of {@link ResourceSkuRestrictionsType} that the service accepts. */
 export declare enum KnownResourceSkuRestrictionsType {
+    /** Location */
     Location = "location",
+    /** Zone */
     Zone = "zone"
 }
 
 /** Known values of {@link SkuCapacityScaleType} that the service accepts. */
 export declare enum KnownSkuCapacityScaleType {
+    /** Automatic */
     Automatic = "Automatic",
+    /** Manual */
     Manual = "Manual",
+    /** None */
     None = "None"
 }
 

package/types/tsdoc-metadata.json

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