@azure/arm-domainservices 4.0.2-alpha.20221102.1 → 4.1.0

package/src/models/index.ts

@@ -376,7 +376,7 @@ export interface ContainerAccount {
 }
 
 /** Domain service. */
-export type DomainService = Resource & {
+export interface DomainService extends Resource {
   /**
    * Data Model Version
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -427,10 +427,10 @@ export type DomainService = Resource & {
   readonly provisioningState?: string;
   /** Configuration diagnostics data containing latest execution from client. */
   configDiagnostics?: ConfigDiagnostics;
-};
+}
 
 /** Resource for OuContainer. */
-export type OuContainer = Resource & {
+export interface OuContainer extends Resource {
   /**
    * Azure Active Directory tenant id
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -468,11 +468,13 @@ export type OuContainer = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: string;
-};
+}
 
 /** Known values of {@link Ldaps} that the service accepts. */
 export enum KnownLdaps {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -488,7 +490,9 @@ export type Ldaps = string;
 
 /** Known values of {@link ExternalAccess} that the service accepts. */
 export enum KnownExternalAccess {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -504,7 +508,9 @@ export type ExternalAccess = string;
 
 /** Known values of {@link NtlmV1} that the service accepts. */
 export enum KnownNtlmV1 {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -520,7 +526,9 @@ export type NtlmV1 = string;
 
 /** Known values of {@link TlsV1} that the service accepts. */
 export enum KnownTlsV1 {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -536,7 +544,9 @@ export type TlsV1 = string;
 
 /** Known values of {@link SyncNtlmPasswords} that the service accepts. */
 export enum KnownSyncNtlmPasswords {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -552,7 +562,9 @@ export type SyncNtlmPasswords = string;
 
 /** Known values of {@link SyncKerberosPasswords} that the service accepts. */
 export enum KnownSyncKerberosPasswords {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -568,7 +580,9 @@ export type SyncKerberosPasswords = string;
 
 /** Known values of {@link SyncOnPremPasswords} that the service accepts. */
 export enum KnownSyncOnPremPasswords {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -584,7 +598,9 @@ export type SyncOnPremPasswords = string;
 
 /** Known values of {@link KerberosRc4Encryption} that the service accepts. */
 export enum KnownKerberosRc4Encryption {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -600,7 +616,9 @@ export type KerberosRc4Encryption = string;
 
 /** Known values of {@link KerberosArmoring} that the service accepts. */
 export enum KnownKerberosArmoring {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -616,7 +634,9 @@ export type KerberosArmoring = string;
 
 /** Known values of {@link FilteredSync} that the service accepts. */
 export enum KnownFilteredSync {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -632,7 +652,9 @@ export type FilteredSync = string;
 
 /** Known values of {@link NotifyGlobalAdmins} that the service accepts. */
 export enum KnownNotifyGlobalAdmins {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -648,7 +670,9 @@ export type NotifyGlobalAdmins = string;
 
 /** Known values of {@link NotifyDcAdmins} that the service accepts. */
 export enum KnownNotifyDcAdmins {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -664,11 +688,17 @@ export type NotifyDcAdmins = string;
 
 /** Known values of {@link Status} that the service accepts. */
 export enum KnownStatus {
+  /** None */
   None = "None",
+  /** Running */
   Running = "Running",
+  /** OK */
   OK = "OK",
+  /** Failure */
   Failure = "Failure",
+  /** Warning */
   Warning = "Warning",
+  /** Skipped */
   Skipped = "Skipped"
 }
 
@@ -688,9 +718,13 @@ export type Status = 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/domainServiceOperations.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 { DomainServiceOperations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -48,22 +49,34 @@ export class DomainServiceOperationsImpl implements DomainServiceOperations {
       [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?: DomainServiceOperationsListOptionalParams
+    options?: DomainServiceOperationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<OperationEntity[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: DomainServiceOperationsListResponse;
+    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/domainServices.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 { DomainServices } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,9 +19,9 @@ import {
   DomainService,
   DomainServicesListNextOptionalParams,
   DomainServicesListOptionalParams,
+  DomainServicesListResponse,
   DomainServicesListByResourceGroupNextOptionalParams,
   DomainServicesListByResourceGroupOptionalParams,
-  DomainServicesListResponse,
   DomainServicesListByResourceGroupResponse,
   DomainServicesCreateOrUpdateOptionalParams,
   DomainServicesCreateOrUpdateResponse,
@@ -62,22 +63,34 @@ export class DomainServicesImpl implements DomainServices {
       [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?: DomainServicesListOptionalParams
+    options?: DomainServicesListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<DomainService[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: DomainServicesListResponse;
+    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;
     }
   }
 
@@ -108,19 +121,33 @@ export class DomainServicesImpl implements DomainServices {
       [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?: DomainServicesListByResourceGroupOptionalParams
+    options?: DomainServicesListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<DomainService[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: DomainServicesListByResourceGroupResponse;
+    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,
@@ -128,7 +155,9 @@ export class DomainServicesImpl implements DomainServices {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/ouContainerOperationGrp.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 { OuContainerOperationGrp } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -67,11 +68,15 @@ export class OuContainerOperationGrpImpl implements OuContainerOperationGrp {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listPagingPage(
           resourceGroupName,
           domainServiceName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -80,15 +85,18 @@ export class OuContainerOperationGrpImpl implements OuContainerOperationGrp {
   private async *listPagingPage(
     resourceGroupName: string,
     domainServiceName: string,
-    options?: OuContainerListOptionalParams
+    options?: OuContainerListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<OuContainer[]> {
-    let result = await this._list(
-      resourceGroupName,
-      domainServiceName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: OuContainerListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, domainServiceName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         resourceGroupName,
@@ -97,7 +105,9 @@ export class OuContainerOperationGrpImpl implements OuContainerOperationGrp {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/ouContainerOperations.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 { OuContainerOperations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -48,22 +49,34 @@ export class OuContainerOperationsImpl implements OuContainerOperations {
       [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?: OuContainerOperationsListOptionalParams
+    options?: OuContainerOperationsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<OperationEntity[]> {
-    let result = await this._list(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: OuContainerOperationsListResponse;
+    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/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/types/arm-domainservices.d.ts

@@ -91,7 +91,7 @@ export declare interface DomainSecuritySettings {
 }
 
 /** Domain service. */
-export declare type DomainService = Resource & {
+export declare interface DomainService extends Resource {
     /**
      * Data Model Version
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -142,7 +142,7 @@ export declare type DomainService = Resource & {
     readonly provisioningState?: string;
     /** Configuration diagnostics data containing latest execution from client. */
     configDiagnostics?: ConfigDiagnostics;
-};
+}
 
 /** The response from the List Domain Services operation. */
 export declare interface DomainServiceListResult {
@@ -328,6 +328,8 @@ export declare class DomainServicesResourceProvider extends coreClient.ServiceCl
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DomainServicesResourceProviderOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     domainServiceOperations: DomainServiceOperations;
     domainServices: DomainServices;
     ouContainerOperations: OuContainerOperations;
@@ -389,6 +391,15 @@ export declare interface ForestTrust {
     trustPassword?: string;
 }
 
+/**
+ * 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;
+
 /** Health Alert Description */
 export declare interface HealthAlert {
     /**
@@ -469,91 +480,125 @@ export declare type KerberosRc4Encryption = string;
 
 /** 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 ExternalAccess} that the service accepts. */
 export declare enum KnownExternalAccess {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link FilteredSync} that the service accepts. */
 export declare enum KnownFilteredSync {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link KerberosArmoring} that the service accepts. */
 export declare enum KnownKerberosArmoring {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link KerberosRc4Encryption} that the service accepts. */
 export declare enum KnownKerberosRc4Encryption {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link Ldaps} that the service accepts. */
 export declare enum KnownLdaps {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link NotifyDcAdmins} that the service accepts. */
 export declare enum KnownNotifyDcAdmins {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link NotifyGlobalAdmins} that the service accepts. */
 export declare enum KnownNotifyGlobalAdmins {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link NtlmV1} that the service accepts. */
 export declare enum KnownNtlmV1 {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link Status} that the service accepts. */
 export declare enum KnownStatus {
+    /** None */
     None = "None",
+    /** Running */
     Running = "Running",
+    /** OK */
     OK = "OK",
+    /** Failure */
     Failure = "Failure",
+    /** Warning */
     Warning = "Warning",
+    /** Skipped */
     Skipped = "Skipped"
 }
 
 /** Known values of {@link SyncKerberosPasswords} that the service accepts. */
 export declare enum KnownSyncKerberosPasswords {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link SyncNtlmPasswords} that the service accepts. */
 export declare enum KnownSyncNtlmPasswords {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link SyncOnPremPasswords} that the service accepts. */
 export declare enum KnownSyncOnPremPasswords {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link TlsV1} that the service accepts. */
 export declare enum KnownTlsV1 {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
@@ -695,7 +740,7 @@ export declare interface OperationEntityListResult {
 }
 
 /** Resource for OuContainer. */
-export declare type OuContainer = Resource & {
+export declare interface OuContainer extends Resource {
     /**
      * Azure Active Directory tenant id
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -733,7 +778,7 @@ export declare type OuContainer = Resource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly provisioningState?: string;
-};
+}
 
 /** Optional parameters. */
 export declare interface OuContainerCreateOptionalParams extends coreClient.OperationOptions {