@azure/arm-portal 1.0.0-beta.3 → 1.0.0-beta.5

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<ResourceProviderOperation[]> {
-    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;
     }
   }
 
@@ -130,7 +143,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

package/src/operations/tenantConfigurations.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 { TenantConfigurations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -54,22 +55,34 @@ export class TenantConfigurationsImpl implements TenantConfigurations {
       [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?: TenantConfigurationsListOptionalParams
+    options?: TenantConfigurationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Configuration[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: TenantConfigurationsListResponse;
+    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;
     }
   }
 
@@ -237,7 +250,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

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

package/src/portal.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,
@@ -56,47 +61,53 @@ export class Portal extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.3`;
+    const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.5`;
     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;
@@ -110,6 +121,35 @@ export class Portal extends coreClient.ServiceClient {
     this.listTenantConfigurationViolations = new ListTenantConfigurationViolationsImpl(
       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/types/arm-portal.d.ts

@@ -3,10 +3,10 @@ import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 
 /** Tenant configuration. */
-export declare type Configuration = ProxyResource & {
+export declare interface Configuration extends ProxyResource {
     /** When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. */
     enforcePrivateMarkdownStorage?: boolean;
-};
+}
 
 /** List of tenant configurations. */
 export declare interface ConfigurationList {
@@ -233,8 +233,18 @@ export declare interface ErrorResponse {
     error?: ErrorDefinition;
 }
 
+/**
+ * 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 declare function getContinuationToken(page: unknown): string | undefined;
+
 /** Known values of {@link ConfigurationName} that the service accepts. */
 export declare enum KnownConfigurationName {
+    /** Default */
     Default = "default"
 }
 
@@ -262,14 +272,14 @@ export declare interface ListTenantConfigurationViolationsListOptionalParams ext
 export declare type ListTenantConfigurationViolationsListResponse = ViolationsList;
 
 /** Markdown part metadata. */
-export declare type MarkdownPartMetadata = DashboardPartMetadata & {
+export declare interface MarkdownPartMetadata extends DashboardPartMetadata {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     type: "Extension/HubsExtension/PartType/MarkdownPart";
     /** Input to dashboard part. */
     inputs?: Record<string, unknown>[];
     /** Markdown part settings. */
     settings?: MarkdownPartMetadataSettings;
-};
+}
 
 /** Markdown part settings. */
 export declare interface MarkdownPartMetadataSettings {
@@ -346,6 +356,8 @@ export declare class Portal extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: PortalOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     operations: Operations;
     dashboards: Dashboards;
     tenantConfigurations: TenantConfigurations;
@@ -363,7 +375,8 @@ export declare interface PortalOptionalParams extends coreClient.ServiceClientOp
 }
 
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export declare type ProxyResource = Resource & {};
+export declare interface ProxyResource extends Resource {
+}
 
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {

package/types/tsdoc-metadata.json

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