@azure/arm-automation 11.0.0-beta.2 → 11.0.0-beta.4

package/src/operations/webhookOperations.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 { WebhookOperations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,6 +17,7 @@ import {
   Webhook,
   WebhookListByAutomationAccountNextOptionalParams,
   WebhookListByAutomationAccountOptionalParams,
+  WebhookListByAutomationAccountResponse,
   WebhookGenerateUriOptionalParams,
   WebhookGenerateUriResponse,
   WebhookDeleteOptionalParams,
@@ -27,7 +29,6 @@ import {
   WebhookUpdateParameters,
   WebhookUpdateOptionalParams,
   WebhookUpdateResponse,
-  WebhookListByAutomationAccountResponse,
   WebhookListByAutomationAccountNextResponse
 } from "../models";
 
@@ -67,11 +68,15 @@ export class WebhookOperationsImpl implements WebhookOperations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listByAutomationAccountPagingPage(
           resourceGroupName,
           automationAccountName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -80,15 +85,22 @@ export class WebhookOperationsImpl implements WebhookOperations {
   private async *listByAutomationAccountPagingPage(
     resourceGroupName: string,
     automationAccountName: string,
-    options?: WebhookListByAutomationAccountOptionalParams
+    options?: WebhookListByAutomationAccountOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Webhook[]> {
-    let result = await this._listByAutomationAccount(
-      resourceGroupName,
-      automationAccountName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: WebhookListByAutomationAccountResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByAutomationAccount(
+        resourceGroupName,
+        automationAccountName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByAutomationAccountNext(
         resourceGroupName,
@@ -97,7 +109,9 @@ export class WebhookOperationsImpl implements WebhookOperations {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -416,7 +430,6 @@ const listByAutomationAccountNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  queryParameters: [Parameters.filter, Parameters.apiVersion4],
   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);
+}

package/tsconfig.json

@@ -15,11 +15,17 @@
     ],
     "declaration": true,
     "outDir": "./dist-esm",
-    "importHelpers": true
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-automation": [
+        "./src/index"
+      ]
+    }
   },
   "include": [
     "./src/**/*.ts",
-    "./test/**/*.ts"
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
   ],
   "exclude": [
     "node_modules"

package/types/arm-automation.d.ts

@@ -805,7 +805,7 @@ export declare interface ConnectionOperations {
 }
 
 /** Definition of the connection type. */
-declare interface ConnectionType_2 {
+export declare interface ConnectionType {
     /**
      * Gets the id of the resource.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -840,7 +840,6 @@ declare interface ConnectionType_2 {
     /** Gets or sets the description. */
     description?: string;
 }
-export { ConnectionType_2 as ConnectionType }
 
 /** The connection type property associated with the entity. */
 export declare interface ConnectionTypeAssociationProperty {
@@ -865,7 +864,7 @@ export declare interface ConnectionTypeCreateOrUpdateParameters {
 }
 
 /** Contains response data for the createOrUpdate operation. */
-export declare type ConnectionTypeCreateOrUpdateResponse = ConnectionType_2;
+export declare type ConnectionTypeCreateOrUpdateResponse = ConnectionType;
 
 /** Optional parameters. */
 export declare interface ConnectionTypeDeleteOptionalParams extends coreClient.OperationOptions {
@@ -876,7 +875,7 @@ export declare interface ConnectionTypeGetOptionalParams extends coreClient.Oper
 }
 
 /** Contains response data for the get operation. */
-export declare type ConnectionTypeGetResponse = ConnectionType_2;
+export declare type ConnectionTypeGetResponse = ConnectionType;
 
 /** Optional parameters. */
 export declare interface ConnectionTypeListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
@@ -895,7 +894,7 @@ export declare type ConnectionTypeListByAutomationAccountResponse = ConnectionTy
 /** The response model for the list connection type operation. */
 export declare interface ConnectionTypeListResult {
     /** Gets or sets a list of connection types. */
-    value?: ConnectionType_2[];
+    value?: ConnectionType[];
     /** Gets or sets the next link. */
     nextLink?: string;
 }
@@ -908,7 +907,7 @@ export declare interface ConnectionTypeOperations {
      * @param automationAccountName The name of the automation account.
      * @param options The options parameters.
      */
-    listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: ConnectionTypeListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<ConnectionType_2>;
+    listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: ConnectionTypeListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<ConnectionType>;
     /**
      * Delete the connection type.
      * @param resourceGroupName Name of an Azure Resource group.
@@ -1312,8 +1311,6 @@ export declare type DscCompilationJobGetStreamResponse = JobStream;
 
 /** Optional parameters. */
 export declare interface DscCompilationJobListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -1493,14 +1490,6 @@ export declare type DscConfigurationGetResponse = DscConfiguration;
 
 /** Optional parameters. */
 export declare interface DscConfigurationListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
-    /** The number of rows to skip. */
-    skip?: number;
-    /** The number of rows to take. */
-    top?: number;
-    /** Return total rows. */
-    inlinecount?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -1757,14 +1746,6 @@ export declare type DscNodeConfigurationGetResponse = DscNodeConfiguration;
 
 /** Optional parameters. */
 export declare interface DscNodeConfigurationListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
-    /** The number of rows to skip. */
-    skip?: number;
-    /** The number of rows to take. */
-    top?: number;
-    /** Return total rows. */
-    inlinecount?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -1861,14 +1842,6 @@ export declare type DscNodeGetResponse = DscNode;
 
 /** Optional parameters. */
 export declare interface DscNodeListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
-    /** The number of rows to skip. */
-    skip?: number;
-    /** The number of rows to take. */
-    top?: number;
-    /** Return total rows. */
-    inlinecount?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -2107,6 +2080,15 @@ export declare interface FieldsListByTypeOptionalParams extends coreClient.Opera
 /** Contains response data for the listByType operation. */
 export declare type FieldsListByTypeResponse = TypeFieldListResult;
 
+/**
+ * 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;
+
 /** Graphical Runbook Content */
 export declare interface GraphicalRunbookContent {
     /** Raw graphical Runbook content. */
@@ -2260,8 +2242,6 @@ export declare type HybridRunbookWorkerGroupGetResponse = HybridRunbookWorkerGro
 
 /** Optional parameters. */
 export declare interface HybridRunbookWorkerGroupListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -2414,8 +2394,6 @@ export declare type HybridRunbookWorkersGetResponse = HybridRunbookWorker;
 
 /** Optional parameters. */
 export declare interface HybridRunbookWorkersListByHybridRunbookWorkerGroupNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByHybridRunbookWorkerGroupNext operation. */
@@ -2598,8 +2576,6 @@ export declare type JobGetRunbookContentResponse = {
 
 /** Optional parameters. */
 export declare interface JobListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
     /** Identifies this specific client request. */
     clientRequestId?: string;
 }
@@ -2789,8 +2765,6 @@ export declare type JobScheduleGetResponse = JobSchedule;
 
 /** Optional parameters. */
 export declare interface JobScheduleListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -2907,8 +2881,6 @@ export declare type JobStreamGetResponse = JobStream;
 
 /** Optional parameters. */
 export declare interface JobStreamListByJobNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
     /** Identifies this specific client request. */
     clientRequestId?: string;
 }
@@ -3728,8 +3700,6 @@ export declare type NodeReportsGetResponse = DscNodeReport;
 
 /** Optional parameters. */
 export declare interface NodeReportsListByNodeNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByNodeNext operation. */
@@ -5293,8 +5263,6 @@ export declare type SourceControlGetResponse = SourceControl;
 
 /** Optional parameters. */
 export declare interface SourceControlListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -5462,8 +5430,6 @@ export declare type SourceControlSyncJobGetResponse = SourceControlSyncJobById;
 
 /** Optional parameters. */
 export declare interface SourceControlSyncJobListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -5606,8 +5572,6 @@ export declare interface SourceControlSyncJobStreamsListBySyncJob {
 
 /** Optional parameters. */
 export declare interface SourceControlSyncJobStreamsListBySyncJobNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listBySyncJobNext operation. */
@@ -5948,8 +5912,6 @@ export declare type TestJobStreamsGetResponse = JobStream;
 
 /** Optional parameters. */
 export declare interface TestJobStreamsListByTestJobNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByTestJobNext operation. */
@@ -6269,8 +6231,6 @@ export declare type WatcherGetResponse = Watcher;
 
 /** Optional parameters. */
 export declare interface WatcherListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */
@@ -6454,8 +6414,6 @@ export declare type WebhookGetResponse = Webhook;
 
 /** Optional parameters. */
 export declare interface WebhookListByAutomationAccountNextOptionalParams extends coreClient.OperationOptions {
-    /** The filter to apply on the operation. */
-    filter?: string;
 }
 
 /** Contains response data for the listByAutomationAccountNext operation. */

package/types/tsdoc-metadata.json

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