@azure/arm-machinelearningexperimentation 2.0.0-beta.2 → 2.0.0-beta.4

package/review/arm-machinelearningexperimentation.api.md

@@ -9,18 +9,18 @@ import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 
 // @public
-export type Account = Resource & {
-    vsoAccountId?: string;
+export interface Account extends Resource {
     readonly accountId?: string;
+    readonly creationDate?: Date;
     description?: string;
+    readonly discoveryUri?: string;
     friendlyName?: string;
     keyVaultId?: string;
+    readonly provisioningState?: ProvisioningState;
     seats?: string;
-    readonly discoveryUri?: string;
-    readonly creationDate?: Date;
     storageAccount?: StorageAccountProperties;
-    readonly provisioningState?: ProvisioningState;
-};
+    vsoAccountId?: string;
+}
 
 // @public
 export interface AccountListResult {
@@ -108,6 +108,9 @@ export interface ErrorResponse {
     message: string;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public (undocumented)
 export class MLTeamAccountManagementClient extends coreClient.ServiceClient {
     // (undocumented)
@@ -166,16 +169,16 @@ export interface OperationsListOptionalParams extends coreClient.OperationOption
 export type OperationsListResponse = OperationListResult;
 
 // @public
-export type Project = Resource & {
-    description?: string;
+export interface Project extends Resource {
     readonly accountId?: string;
-    readonly workspaceId?: string;
-    readonly projectId?: string;
-    gitrepo?: string;
-    friendlyName?: string;
     readonly creationDate?: Date;
+    description?: string;
+    friendlyName?: string;
+    gitrepo?: string;
+    readonly projectId?: string;
     readonly provisioningState?: ProvisioningState;
-};
+    readonly workspaceId?: string;
+}
 
 // @public
 export interface ProjectListResult {
@@ -262,14 +265,14 @@ export interface StorageAccountProperties {
 }
 
 // @public
-export type Workspace = Resource & {
-    description?: string;
+export interface Workspace extends Resource {
     readonly accountId?: string;
-    readonly workspaceId?: string;
-    friendlyName?: string;
     readonly creationDate?: Date;
+    description?: string;
+    friendlyName?: string;
     readonly provisioningState?: ProvisioningState;
-};
+    readonly workspaceId?: string;
+}
 
 // @public
 export interface WorkspaceListResult {

package/src/index.ts

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

package/src/mLTeamAccountManagementClient.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,
@@ -55,47 +60,53 @@ export class MLTeamAccountManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-machinelearningexperimentation/2.0.0-beta.2`;
+    const packageDetails = `azsdk-js-arm-machinelearningexperimentation/2.0.0-beta.4`;
     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();
-      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;
@@ -107,6 +118,35 @@ export class MLTeamAccountManagementClient extends coreClient.ServiceClient {
     this.accounts = new AccountsImpl(this);
     this.workspaces = new WorkspacesImpl(this);
     this.projects = new ProjectsImpl(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/models/index.ts

@@ -134,7 +134,7 @@ export interface ProjectListResult {
 }
 
 /** An object that represents a machine learning team account. */
-export type Account = Resource & {
+export interface Account extends Resource {
   /** The fully qualified arm id of the vso account to be used for this team account. */
   vsoAccountId?: string;
   /**
@@ -167,10 +167,10 @@ export type Account = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: ProvisioningState;
-};
+}
 
 /** An object that represents a machine learning team account workspace. */
-export type Workspace = Resource & {
+export interface Workspace extends Resource {
   /** The description of this workspace. */
   description?: string;
   /**
@@ -195,10 +195,10 @@ export type Workspace = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: ProvisioningState;
-};
+}
 
 /** An object that represents a machine learning project. */
-export type Project = Resource & {
+export interface Project extends Resource {
   /** The description of this project. */
   description?: string;
   /**
@@ -230,7 +230,8 @@ export type Project = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: ProvisioningState;
-};
+}
+
 /** Defines values for ProvisioningState. */
 export type ProvisioningState =
   | "Creating"

package/src/operations/accounts.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 { Accounts } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,8 +17,10 @@ import {
   Account,
   AccountsListByResourceGroupNextOptionalParams,
   AccountsListByResourceGroupOptionalParams,
+  AccountsListByResourceGroupResponse,
   AccountsListNextOptionalParams,
   AccountsListOptionalParams,
+  AccountsListResponse,
   AccountsGetOptionalParams,
   AccountsGetResponse,
   AccountsCreateOrUpdateOptionalParams,
@@ -26,8 +29,6 @@ import {
   AccountUpdateParameters,
   AccountsUpdateOptionalParams,
   AccountsUpdateResponse,
-  AccountsListByResourceGroupResponse,
-  AccountsListResponse,
   AccountsListByResourceGroupNextResponse,
   AccountsListNextResponse
 } from "../models";
@@ -63,19 +64,33 @@ export class AccountsImpl implements Accounts {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listByResourceGroupPagingPage(resourceGroupName, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listByResourceGroupPagingPage(
+          resourceGroupName,
+          options,
+          settings
+        );
       }
     };
   }
 
   private async *listByResourceGroupPagingPage(
     resourceGroupName: string,
-    options?: AccountsListByResourceGroupOptionalParams
+    options?: AccountsListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Account[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: AccountsListByResourceGroupResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByResourceGroup(resourceGroupName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByResourceGroupNext(
         resourceGroupName,
@@ -83,7 +98,9 @@ export class AccountsImpl implements Accounts {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -114,22 +131,34 @@ export class AccountsImpl implements Accounts {
       [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?: AccountsListOptionalParams
+    options?: AccountsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Account[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: AccountsListResponse;
+    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;
     }
   }
 
@@ -422,7 +451,6 @@ const listByResourceGroupNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,
@@ -443,7 +471,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

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<Operation[]> {
-    let result = await this._list(options);
+    let result: OperationsListResponse;
+    result = await this._list(options);
     yield result.value || [];
   }
 

package/src/operations/projects.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 { Projects } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,6 +17,7 @@ import {
   Project,
   ProjectsListByWorkspaceNextOptionalParams,
   ProjectsListByWorkspaceOptionalParams,
+  ProjectsListByWorkspaceResponse,
   ProjectsGetOptionalParams,
   ProjectsGetResponse,
   ProjectsCreateOrUpdateOptionalParams,
@@ -24,7 +26,6 @@ import {
   ProjectUpdateParameters,
   ProjectsUpdateOptionalParams,
   ProjectsUpdateResponse,
-  ProjectsListByWorkspaceResponse,
   ProjectsListByWorkspaceNextResponse
 } from "../models";
 
@@ -68,12 +69,16 @@ export class ProjectsImpl implements Projects {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listByWorkspacePagingPage(
           accountName,
           workspaceName,
           resourceGroupName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -83,16 +88,23 @@ export class ProjectsImpl implements Projects {
     accountName: string,
     workspaceName: string,
     resourceGroupName: string,
-    options?: ProjectsListByWorkspaceOptionalParams
+    options?: ProjectsListByWorkspaceOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Project[]> {
-    let result = await this._listByWorkspace(
-      accountName,
-      workspaceName,
-      resourceGroupName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ProjectsListByWorkspaceResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByWorkspace(
+        accountName,
+        workspaceName,
+        resourceGroupName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByWorkspaceNext(
         accountName,
@@ -102,7 +114,9 @@ export class ProjectsImpl implements Projects {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -409,7 +423,6 @@ const listByWorkspaceNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

package/src/operations/workspaces.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 { Workspaces } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,6 +17,7 @@ import {
   Workspace,
   WorkspacesListByAccountsNextOptionalParams,
   WorkspacesListByAccountsOptionalParams,
+  WorkspacesListByAccountsResponse,
   WorkspacesGetOptionalParams,
   WorkspacesGetResponse,
   WorkspacesCreateOrUpdateOptionalParams,
@@ -24,7 +26,6 @@ import {
   WorkspaceUpdateParameters,
   WorkspacesUpdateOptionalParams,
   WorkspacesUpdateResponse,
-  WorkspacesListByAccountsResponse,
   WorkspacesListByAccountsNextResponse
 } from "../models";
 
@@ -65,11 +66,15 @@ export class WorkspacesImpl implements Workspaces {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listByAccountsPagingPage(
           accountName,
           resourceGroupName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -78,15 +83,22 @@ export class WorkspacesImpl implements Workspaces {
   private async *listByAccountsPagingPage(
     accountName: string,
     resourceGroupName: string,
-    options?: WorkspacesListByAccountsOptionalParams
+    options?: WorkspacesListByAccountsOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Workspace[]> {
-    let result = await this._listByAccounts(
-      accountName,
-      resourceGroupName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: WorkspacesListByAccountsResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByAccounts(
+        accountName,
+        resourceGroupName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByAccountsNext(
         accountName,
@@ -95,7 +107,9 @@ export class WorkspacesImpl implements Workspaces {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -369,7 +383,6 @@ const listByAccountsNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.subscriptionId,

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 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);
+}