@azure/arm-managedapplications 2.0.2-alpha.20221026.1 → 2.1.0-alpha.20221128.2

package/review/arm-managedapplications.api.md

@@ -11,15 +11,15 @@ import { PollerLike } from '@azure/core-lro';
 import { PollOperationState } from '@azure/core-lro';
 
 // @public
-export type Application = GenericResource & {
-    plan?: Plan;
+export interface Application extends GenericResource {
+    applicationDefinitionId?: string;
     kind: string;
     managedResourceGroupId: string;
-    applicationDefinitionId?: string;
-    parameters?: Record<string, unknown>;
     readonly outputs?: Record<string, unknown>;
+    parameters?: Record<string, unknown>;
+    plan?: Plan;
     readonly provisioningState?: ProvisioningState;
-};
+}
 
 // @public
 export interface ApplicationArtifact {
@@ -55,17 +55,17 @@ export interface ApplicationClientOptionalParams extends coreClient.ServiceClien
 }
 
 // @public
-export type ApplicationDefinition = GenericResource & {
-    lockLevel: ApplicationLockLevel;
-    displayName?: string;
-    isEnabled?: string;
-    authorizations: ApplicationProviderAuthorization[];
+export interface ApplicationDefinition extends GenericResource {
     artifacts?: ApplicationArtifact[];
+    authorizations: ApplicationProviderAuthorization[];
+    createUiDefinition?: Record<string, unknown>;
     description?: string;
-    packageFileUri?: string;
+    displayName?: string;
+    isEnabled?: string;
+    lockLevel: ApplicationLockLevel;
     mainTemplate?: Record<string, unknown>;
-    createUiDefinition?: Record<string, unknown>;
-};
+    packageFileUri?: string;
+}
 
 // @public
 export interface ApplicationDefinitionListResult {
@@ -156,15 +156,15 @@ export interface ApplicationListResult {
 export type ApplicationLockLevel = "CanNotDelete" | "ReadOnly" | "None";
 
 // @public
-export type ApplicationPatchable = GenericResource & {
-    plan?: PlanPatchable;
+export interface ApplicationPatchable extends GenericResource {
+    applicationDefinitionId?: string;
     kind?: string;
     managedResourceGroupId?: string;
-    applicationDefinitionId?: string;
-    parameters?: Record<string, unknown>;
     readonly outputs?: Record<string, unknown>;
+    parameters?: Record<string, unknown>;
+    plan?: PlanPatchable;
     readonly provisioningState?: ProvisioningState;
-};
+}
 
 // @public
 export interface ApplicationProviderAuthorization {
@@ -286,11 +286,14 @@ export interface ErrorResponse {
 }
 
 // @public
-export type GenericResource = Resource & {
+export interface GenericResource extends Resource {
+    identity?: Identity;
     managedBy?: string;
     sku?: Sku;
-    identity?: Identity;
-};
+}
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
 
 // @public
 export interface Identity {
@@ -301,27 +304,16 @@ export interface Identity {
 
 // @public
 export enum KnownProvisioningState {
-    // (undocumented)
     Accepted = "Accepted",
-    // (undocumented)
     Canceled = "Canceled",
-    // (undocumented)
     Created = "Created",
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleted = "Deleted",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Ready = "Ready",
-    // (undocumented)
     Running = "Running",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 

package/src/applicationClient.ts

@@ -8,8 +8,14 @@
 
 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 { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "./pagingHelper";
 import { ApplicationsImpl, ApplicationDefinitionsImpl } from "./operations";
 import { Applications, ApplicationDefinitions } from "./operationsInterfaces";
 import * as Parameters from "./models/parameters";
@@ -56,47 +62,53 @@ export class ApplicationClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-managedapplications/2.0.2`;
+    const packageDetails = `azsdk-js-arm-managedapplications/2.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();
-      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;
@@ -106,6 +118,35 @@ export class ApplicationClient extends coreClient.ServiceClient {
     this.apiVersion = options.apiVersion || "2018-06-01";
     this.applications = new ApplicationsImpl(this);
     this.applicationDefinitions = new ApplicationDefinitionsImpl(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);
   }
 
   /**
@@ -123,22 +164,34 @@ export class ApplicationClient extends coreClient.ServiceClient {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listOperationsPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listOperationsPagingPage(options, settings);
       }
     };
   }
 
   private async *listOperationsPagingPage(
-    options?: ListOperationsOptionalParams
+    options?: ListOperationsOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Operation[]> {
-    let result = await this._listOperations(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ListOperationsResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listOperations(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listOperationsNext(continuationToken, options);
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/index.ts

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

package/src/models/index.ts

@@ -162,17 +162,17 @@ export interface ApplicationListResult {
 }
 
 /** Resource information. */
-export type GenericResource = Resource & {
+export interface GenericResource extends Resource {
   /** ID of the resource that manages this resource. */
   managedBy?: string;
   /** The SKU of the resource. */
   sku?: Sku;
   /** The identity of the resource. */
   identity?: Identity;
-};
+}
 
 /** Information about managed application. */
-export type Application = GenericResource & {
+export interface Application extends GenericResource {
   /** The plan information. */
   plan?: Plan;
   /** The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. */
@@ -193,10 +193,10 @@ export type Application = GenericResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: ProvisioningState;
-};
+}
 
 /** Information about managed application. */
-export type ApplicationPatchable = GenericResource & {
+export interface ApplicationPatchable extends GenericResource {
   /** The plan information. */
   plan?: PlanPatchable;
   /** The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. */
@@ -217,10 +217,10 @@ export type ApplicationPatchable = GenericResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: ProvisioningState;
-};
+}
 
 /** Information about managed application definition. */
-export type ApplicationDefinition = GenericResource & {
+export interface ApplicationDefinition extends GenericResource {
   /** The managed application lock level. */
   lockLevel: ApplicationLockLevel;
   /** The managed application definition display name. */
@@ -239,20 +239,31 @@ export type ApplicationDefinition = GenericResource & {
   mainTemplate?: Record<string, unknown>;
   /** The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. */
   createUiDefinition?: Record<string, unknown>;
-};
+}
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export enum KnownProvisioningState {
+  /** Accepted */
   Accepted = "Accepted",
+  /** Running */
   Running = "Running",
+  /** Ready */
   Ready = "Ready",
+  /** Creating */
   Creating = "Creating",
+  /** Created */
   Created = "Created",
+  /** Deleting */
   Deleting = "Deleting",
+  /** Deleted */
   Deleted = "Deleted",
+  /** Canceled */
   Canceled = "Canceled",
+  /** Failed */
   Failed = "Failed",
+  /** Succeeded */
   Succeeded = "Succeeded",
+  /** Updating */
   Updating = "Updating"
 }
 

package/src/operations/applicationDefinitions.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 { ApplicationDefinitions } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,12 +19,12 @@ import {
   ApplicationDefinition,
   ApplicationDefinitionsListByResourceGroupNextOptionalParams,
   ApplicationDefinitionsListByResourceGroupOptionalParams,
+  ApplicationDefinitionsListByResourceGroupResponse,
   ApplicationDefinitionsGetOptionalParams,
   ApplicationDefinitionsGetResponse,
   ApplicationDefinitionsDeleteOptionalParams,
   ApplicationDefinitionsCreateOrUpdateOptionalParams,
   ApplicationDefinitionsCreateOrUpdateResponse,
-  ApplicationDefinitionsListByResourceGroupResponse,
   ApplicationDefinitionsGetByIdOptionalParams,
   ApplicationDefinitionsGetByIdResponse,
   ApplicationDefinitionsDeleteByIdOptionalParams,
@@ -62,19 +63,33 @@ export class ApplicationDefinitionsImpl implements ApplicationDefinitions {
       [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?: ApplicationDefinitionsListByResourceGroupOptionalParams
+    options?: ApplicationDefinitionsListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ApplicationDefinition[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ApplicationDefinitionsListByResourceGroupResponse;
+    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,
@@ -82,7 +97,9 @@ export class ApplicationDefinitionsImpl implements ApplicationDefinitions {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/applications.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 { Applications } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,8 +19,10 @@ import {
   Application,
   ApplicationsListByResourceGroupNextOptionalParams,
   ApplicationsListByResourceGroupOptionalParams,
+  ApplicationsListByResourceGroupResponse,
   ApplicationsListBySubscriptionNextOptionalParams,
   ApplicationsListBySubscriptionOptionalParams,
+  ApplicationsListBySubscriptionResponse,
   ApplicationsGetOptionalParams,
   ApplicationsGetResponse,
   ApplicationsDeleteOptionalParams,
@@ -27,8 +30,6 @@ import {
   ApplicationsCreateOrUpdateResponse,
   ApplicationsUpdateOptionalParams,
   ApplicationsUpdateResponse,
-  ApplicationsListByResourceGroupResponse,
-  ApplicationsListBySubscriptionResponse,
   ApplicationsGetByIdOptionalParams,
   ApplicationsGetByIdResponse,
   ApplicationsDeleteByIdOptionalParams,
@@ -70,19 +71,33 @@ export class ApplicationsImpl implements Applications {
       [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?: ApplicationsListByResourceGroupOptionalParams
+    options?: ApplicationsListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Application[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ApplicationsListByResourceGroupResponse;
+    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,
@@ -90,7 +105,9 @@ export class ApplicationsImpl implements Applications {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -121,22 +138,34 @@ export class ApplicationsImpl implements Applications {
       [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?: ApplicationsListBySubscriptionOptionalParams
+    options?: ApplicationsListBySubscriptionOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Application[]> {
-    let result = await this._listBySubscription(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ApplicationsListBySubscriptionResponse;
+    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;
     }
   }
 

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/tsconfig.json

@@ -33,8 +33,6 @@
     "./test/**/*.ts",
     "samples-dev/**/*.ts",
     "./test/**/*.ts",
-    "samples-dev/**/*.ts",
-    "./test/**/*.ts",
     "samples-dev/**/*.ts"
   ],
   "exclude": [