@azure/arm-locks 2.1.0-alpha.20221026.1 → 2.1.0

package/src/managementLockClient.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 { AuthorizationOperationsImpl, ManagementLocksImpl } from "./operations";
 import {
@@ -54,41 +59,47 @@ export class ManagementLockClient extends coreClient.ServiceClient {
         ? `${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;
@@ -98,6 +109,35 @@ export class ManagementLockClient extends coreClient.ServiceClient {
     this.apiVersion = options.apiVersion || "2020-05-01";
     this.authorizationOperations = new AuthorizationOperationsImpl(this);
     this.managementLocks = new ManagementLocksImpl(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);
   }
 
   authorizationOperations: AuthorizationOperations;

package/src/models/index.ts

@@ -145,8 +145,11 @@ export interface ManagementLockListResult {
 
 /** Known values of {@link LockLevel} that the service accepts. */
 export enum KnownLockLevel {
+  /** NotSpecified */
   NotSpecified = "NotSpecified",
+  /** CanNotDelete */
   CanNotDelete = "CanNotDelete",
+  /** ReadOnly */
   ReadOnly = "ReadOnly"
 }
 
@@ -163,9 +166,13 @@ export type LockLevel = string;
 
 /** Known values of {@link CreatedByType} that the service accepts. */
 export enum KnownCreatedByType {
+  /** User */
   User = "User",
+  /** Application */
   Application = "Application",
+  /** ManagedIdentity */
   ManagedIdentity = "ManagedIdentity",
+  /** Key */
   Key = "Key"
 }
 

package/src/operations/authorizationOperations.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 { AuthorizationOperations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -48,22 +49,34 @@ export class AuthorizationOperationsImpl implements AuthorizationOperations {
       [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?: AuthorizationOperationsListOptionalParams
+    options?: AuthorizationOperationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Operation[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: AuthorizationOperationsListResponse;
+    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/managementLocks.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 { ManagementLocks } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,12 +17,16 @@ import {
   ManagementLockObject,
   ManagementLocksListAtResourceGroupLevelNextOptionalParams,
   ManagementLocksListAtResourceGroupLevelOptionalParams,
+  ManagementLocksListAtResourceGroupLevelResponse,
   ManagementLocksListAtResourceLevelNextOptionalParams,
   ManagementLocksListAtResourceLevelOptionalParams,
+  ManagementLocksListAtResourceLevelResponse,
   ManagementLocksListAtSubscriptionLevelNextOptionalParams,
   ManagementLocksListAtSubscriptionLevelOptionalParams,
+  ManagementLocksListAtSubscriptionLevelResponse,
   ManagementLocksListByScopeNextOptionalParams,
   ManagementLocksListByScopeOptionalParams,
+  ManagementLocksListByScopeResponse,
   ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams,
   ManagementLocksCreateOrUpdateAtResourceGroupLevelResponse,
   ManagementLocksDeleteAtResourceGroupLevelOptionalParams,
@@ -42,10 +47,6 @@ import {
   ManagementLocksDeleteAtSubscriptionLevelOptionalParams,
   ManagementLocksGetAtSubscriptionLevelOptionalParams,
   ManagementLocksGetAtSubscriptionLevelResponse,
-  ManagementLocksListAtResourceGroupLevelResponse,
-  ManagementLocksListAtResourceLevelResponse,
-  ManagementLocksListAtSubscriptionLevelResponse,
-  ManagementLocksListByScopeResponse,
   ManagementLocksListAtResourceGroupLevelNextResponse,
   ManagementLocksListAtResourceLevelNextResponse,
   ManagementLocksListAtSubscriptionLevelNextResponse,
@@ -85,10 +86,14 @@ export class ManagementLocksImpl implements ManagementLocks {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listAtResourceGroupLevelPagingPage(
           resourceGroupName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -96,14 +101,18 @@ export class ManagementLocksImpl implements ManagementLocks {
 
   private async *listAtResourceGroupLevelPagingPage(
     resourceGroupName: string,
-    options?: ManagementLocksListAtResourceGroupLevelOptionalParams
+    options?: ManagementLocksListAtResourceGroupLevelOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ManagementLockObject[]> {
-    let result = await this._listAtResourceGroupLevel(
-      resourceGroupName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ManagementLocksListAtResourceGroupLevelResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listAtResourceGroupLevel(resourceGroupName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listAtResourceGroupLevelNext(
         resourceGroupName,
@@ -111,7 +120,9 @@ export class ManagementLocksImpl implements ManagementLocks {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -160,14 +171,18 @@ export class ManagementLocksImpl implements ManagementLocks {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listAtResourceLevelPagingPage(
           resourceGroupName,
           resourceProviderNamespace,
           parentResourcePath,
           resourceType,
           resourceName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -179,18 +194,25 @@ export class ManagementLocksImpl implements ManagementLocks {
     parentResourcePath: string,
     resourceType: string,
     resourceName: string,
-    options?: ManagementLocksListAtResourceLevelOptionalParams
+    options?: ManagementLocksListAtResourceLevelOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ManagementLockObject[]> {
-    let result = await this._listAtResourceLevel(
-      resourceGroupName,
-      resourceProviderNamespace,
-      parentResourcePath,
-      resourceType,
-      resourceName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ManagementLocksListAtResourceLevelResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listAtResourceLevel(
+        resourceGroupName,
+        resourceProviderNamespace,
+        parentResourcePath,
+        resourceType,
+        resourceName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listAtResourceLevelNext(
         resourceGroupName,
@@ -202,7 +224,9 @@ export class ManagementLocksImpl implements ManagementLocks {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -241,25 +265,37 @@ export class ManagementLocksImpl implements ManagementLocks {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listAtSubscriptionLevelPagingPage(options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listAtSubscriptionLevelPagingPage(options, settings);
       }
     };
   }
 
   private async *listAtSubscriptionLevelPagingPage(
-    options?: ManagementLocksListAtSubscriptionLevelOptionalParams
+    options?: ManagementLocksListAtSubscriptionLevelOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ManagementLockObject[]> {
-    let result = await this._listAtSubscriptionLevel(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ManagementLocksListAtSubscriptionLevelResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listAtSubscriptionLevel(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listAtSubscriptionLevelNext(
         continuationToken,
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -292,23 +328,35 @@ export class ManagementLocksImpl implements ManagementLocks {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listByScopePagingPage(scope, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listByScopePagingPage(scope, options, settings);
       }
     };
   }
 
   private async *listByScopePagingPage(
     scope: string,
-    options?: ManagementLocksListByScopeOptionalParams
+    options?: ManagementLocksListByScopeOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<ManagementLockObject[]> {
-    let result = await this._listByScope(scope, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: ManagementLocksListByScopeResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByScope(scope, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByScopeNext(scope, 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

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

package/types/arm-locks.d.ts

@@ -86,18 +86,34 @@ export declare interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+/**
+ * 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 CreatedByType} that the service accepts. */
 export declare enum KnownCreatedByType {
+    /** User */
     User = "User",
+    /** Application */
     Application = "Application",
+    /** ManagedIdentity */
     ManagedIdentity = "ManagedIdentity",
+    /** Key */
     Key = "Key"
 }
 
 /** Known values of {@link LockLevel} that the service accepts. */
 export declare enum KnownLockLevel {
+    /** NotSpecified */
     NotSpecified = "NotSpecified",
+    /** CanNotDelete */
     CanNotDelete = "CanNotDelete",
+    /** ReadOnly */
     ReadOnly = "ReadOnly"
 }
 
@@ -123,6 +139,8 @@ export declare class ManagementLockClient extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ManagementLockClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     authorizationOperations: AuthorizationOperations;
     managementLocks: ManagementLocks;
 }

package/types/tsdoc-metadata.json

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