@azure/arm-databricks 3.0.0-beta.3 → 3.0.0-beta.4

package/src/operations/privateEndpointConnections.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 { PrivateEndpointConnections } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -60,8 +61,16 @@ export class PrivateEndpointConnectionsImpl
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(resourceGroupName, workspaceName, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(
+          resourceGroupName,
+          workspaceName,
+          options,
+          settings
+        );
       }
     };
   }
@@ -69,11 +78,18 @@ export class PrivateEndpointConnectionsImpl
   private async *listPagingPage(
     resourceGroupName: string,
     workspaceName: string,
-    options?: PrivateEndpointConnectionsListOptionalParams
+    options?: PrivateEndpointConnectionsListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<PrivateEndpointConnection[]> {
-    let result = await this._list(resourceGroupName, workspaceName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: PrivateEndpointConnectionsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, workspaceName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         resourceGroupName,
@@ -82,7 +98,9 @@ export class PrivateEndpointConnectionsImpl
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/privateLinkResources.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 { PrivateLinkResources } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -54,8 +55,16 @@ export class PrivateLinkResourcesImpl implements PrivateLinkResources {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(resourceGroupName, workspaceName, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(
+          resourceGroupName,
+          workspaceName,
+          options,
+          settings
+        );
       }
     };
   }
@@ -63,11 +72,18 @@ export class PrivateLinkResourcesImpl implements PrivateLinkResources {
   private async *listPagingPage(
     resourceGroupName: string,
     workspaceName: string,
-    options?: PrivateLinkResourcesListOptionalParams
+    options?: PrivateLinkResourcesListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<GroupIdInformation[]> {
-    let result = await this._list(resourceGroupName, workspaceName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: PrivateLinkResourcesListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, workspaceName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         resourceGroupName,
@@ -76,7 +92,9 @@ export class PrivateLinkResourcesImpl implements PrivateLinkResources {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/vNetPeering.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 { VNetPeering } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,12 +19,12 @@ import {
   VirtualNetworkPeering,
   VNetPeeringListByWorkspaceNextOptionalParams,
   VNetPeeringListByWorkspaceOptionalParams,
+  VNetPeeringListByWorkspaceResponse,
   VNetPeeringGetOptionalParams,
   VNetPeeringGetResponse,
   VNetPeeringDeleteOptionalParams,
   VNetPeeringCreateOrUpdateOptionalParams,
   VNetPeeringCreateOrUpdateResponse,
-  VNetPeeringListByWorkspaceResponse,
   VNetPeeringListByWorkspaceNextResponse
 } from "../models";
 
@@ -63,11 +64,15 @@ export class VNetPeeringImpl implements VNetPeering {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
         return this.listByWorkspacePagingPage(
           resourceGroupName,
           workspaceName,
-          options
+          options,
+          settings
         );
       }
     };
@@ -76,15 +81,22 @@ export class VNetPeeringImpl implements VNetPeering {
   private async *listByWorkspacePagingPage(
     resourceGroupName: string,
     workspaceName: string,
-    options?: VNetPeeringListByWorkspaceOptionalParams
+    options?: VNetPeeringListByWorkspaceOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<VirtualNetworkPeering[]> {
-    let result = await this._listByWorkspace(
-      resourceGroupName,
-      workspaceName,
-      options
-    );
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: VNetPeeringListByWorkspaceResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByWorkspace(
+        resourceGroupName,
+        workspaceName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listByWorkspaceNext(
         resourceGroupName,
@@ -93,7 +105,9 @@ export class VNetPeeringImpl implements VNetPeering {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/workspaces.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 { Workspaces } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -18,8 +19,10 @@ import {
   Workspace,
   WorkspacesListByResourceGroupNextOptionalParams,
   WorkspacesListByResourceGroupOptionalParams,
+  WorkspacesListByResourceGroupResponse,
   WorkspacesListBySubscriptionNextOptionalParams,
   WorkspacesListBySubscriptionOptionalParams,
+  WorkspacesListBySubscriptionResponse,
   WorkspacesGetOptionalParams,
   WorkspacesGetResponse,
   WorkspacesDeleteOptionalParams,
@@ -28,8 +31,6 @@ import {
   WorkspaceUpdate,
   WorkspacesUpdateOptionalParams,
   WorkspacesUpdateResponse,
-  WorkspacesListByResourceGroupResponse,
-  WorkspacesListBySubscriptionResponse,
   WorkspacesListByResourceGroupNextResponse,
   WorkspacesListBySubscriptionNextResponse
 } from "../models";
@@ -64,19 +65,33 @@ export class WorkspacesImpl implements Workspaces {
       [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?: WorkspacesListByResourceGroupOptionalParams
+    options?: WorkspacesListByResourceGroupOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Workspace[]> {
-    let result = await this._listByResourceGroup(resourceGroupName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: WorkspacesListByResourceGroupResponse;
+    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,
@@ -84,7 +99,9 @@ export class WorkspacesImpl implements Workspaces {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 
@@ -115,22 +132,34 @@ export class WorkspacesImpl implements Workspaces {
       [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?: WorkspacesListBySubscriptionOptionalParams
+    options?: WorkspacesListBySubscriptionOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Workspace[]> {
-    let result = await this._listBySubscription(options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: WorkspacesListBySubscriptionResponse;
+    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/operationsInterfaces/outboundNetworkDependenciesEndpoints.ts

@@ -16,7 +16,7 @@ export interface OutboundNetworkDependenciesEndpoints {
   /**
    * Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You
    * must configure outbound access with these endpoints. For more information, see
-   * https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr
+   * https://docs.microsoft.com/azure/databricks/administration-guide/cloud-configurations/azure/udr
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param workspaceName The name of the workspace.
    * @param options The options parameters.

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-databricks.d.ts

@@ -21,6 +21,8 @@ export declare class AzureDatabricksManagementClient extends coreClient.ServiceC
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureDatabricksManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     workspaces: Workspaces;
     operations: Operations;
     privateLinkResources: PrivateLinkResources;
@@ -174,11 +176,20 @@ export declare interface ErrorResponse {
     error: ErrorInfo;
 }
 
+/**
+ * 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;
+
 /** The group information for creating a private endpoint on a workspace */
-export declare type GroupIdInformation = Resource & {
+export declare interface GroupIdInformation extends Resource {
     /** The group id properties. */
     properties: GroupIdInformationProperties;
-};
+}
 
 /** The properties for a group information object */
 export declare interface GroupIdInformationProperties {
@@ -202,87 +213,129 @@ export declare type KeySource = 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 CustomParameterType} that the service accepts. */
 export declare enum KnownCustomParameterType {
+    /** Bool */
     Bool = "Bool",
+    /** Object */
     Object = "Object",
+    /** String */
     String = "String"
 }
 
 /** Known values of {@link EncryptionKeySource} that the service accepts. */
 export declare enum KnownEncryptionKeySource {
+    /** MicrosoftKeyvault */
     MicrosoftKeyvault = "Microsoft.Keyvault"
 }
 
 /** Known values of {@link KeySource} that the service accepts. */
 export declare enum KnownKeySource {
+    /** Default */
     Default = "Default",
+    /** MicrosoftKeyvault */
     MicrosoftKeyvault = "Microsoft.Keyvault"
 }
 
 /** Known values of {@link PeeringProvisioningState} that the service accepts. */
 export declare enum KnownPeeringProvisioningState {
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** Updating */
     Updating = "Updating",
+    /** Deleting */
     Deleting = "Deleting",
+    /** Failed */
     Failed = "Failed"
 }
 
 /** Known values of {@link PeeringState} that the service accepts. */
 export declare enum KnownPeeringState {
+    /** Initiated */
     Initiated = "Initiated",
+    /** Connected */
     Connected = "Connected",
+    /** Disconnected */
     Disconnected = "Disconnected"
 }
 
 /** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
 export declare enum KnownPrivateEndpointConnectionProvisioningState {
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** Creating */
     Creating = "Creating",
+    /** Updating */
     Updating = "Updating",
+    /** Deleting */
     Deleting = "Deleting",
+    /** Failed */
     Failed = "Failed"
 }
 
 /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
 export declare enum KnownPrivateLinkServiceConnectionStatus {
+    /** Pending */
     Pending = "Pending",
+    /** Approved */
     Approved = "Approved",
+    /** Rejected */
     Rejected = "Rejected",
+    /** Disconnected */
     Disconnected = "Disconnected"
 }
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export declare 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"
 }
 
 /** Known values of {@link PublicNetworkAccess} that the service accepts. */
 export declare enum KnownPublicNetworkAccess {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link RequiredNsgRules} that the service accepts. */
 export declare enum KnownRequiredNsgRules {
+    /** AllRules */
     AllRules = "AllRules",
+    /** NoAzureDatabricksRules */
     NoAzureDatabricksRules = "NoAzureDatabricksRules",
+    /** NoAzureServiceRules */
     NoAzureServiceRules = "NoAzureServiceRules"
 }
 
@@ -367,7 +420,7 @@ export declare interface OutboundNetworkDependenciesEndpoints {
     /**
      * Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You
      * must configure outbound access with these endpoints. For more information, see
-     * https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr
+     * https://docs.microsoft.com/azure/databricks/administration-guide/cloud-configurations/azure/udr
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param workspaceName The name of the workspace.
      * @param options The options parameters.
@@ -716,14 +769,14 @@ export declare interface SystemData {
 }
 
 /** The resource model definition for a ARM tracked top level resource */
-export declare type TrackedResource = Resource & {
+export declare interface TrackedResource extends Resource {
     /** Resource tags. */
     tags?: {
         [propertyName: string]: string;
     };
     /** The geo-location where the resource lives */
     location: string;
-};
+}
 
 /** Peerings in a VirtualNetwork resource */
 export declare interface VirtualNetworkPeering {
@@ -884,7 +937,7 @@ export declare interface VNetPeeringListByWorkspaceOptionalParams extends coreCl
 export declare type VNetPeeringListByWorkspaceResponse = VirtualNetworkPeeringList;
 
 /** Information about workspace. */
-export declare type Workspace = TrackedResource & {
+export declare interface Workspace extends TrackedResource {
     /** The SKU of the resource. */
     sku?: Sku;
     /**
@@ -937,7 +990,7 @@ export declare type Workspace = TrackedResource & {
     publicNetworkAccess?: PublicNetworkAccess;
     /** Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. */
     requiredNsgRules?: RequiredNsgRules;
-};
+}
 
 /** The value which should be used for this field. */
 export declare interface WorkspaceCustomBooleanParameter {

package/types/tsdoc-metadata.json

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