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

package/package.json

@@ -3,15 +3,15 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for AzureDatabricksManagementClient.",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "dependencies": {
     "@azure/core-lro": "^2.2.0",
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-paging": "^1.2.0",
-    "@azure/core-client": "^1.5.0",
+    "@azure/core-client": "^1.6.1",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-rest-pipeline": "^1.8.0",
     "tslib": "^2.2.0"
@@ -28,7 +28,7 @@
   "module": "./dist-esm/src/index.js",
   "types": "./types/arm-databricks.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.11",
+    "@microsoft/api-extractor": "^7.31.1",
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-multi-entry": "^4.1.0",
@@ -36,13 +36,18 @@
     "mkdirp": "^1.0.4",
     "rollup": "^2.66.1",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "typescript": "~4.2.0",
+    "typescript": "~4.8.0",
     "uglify-js": "^3.4.9",
     "rimraf": "^3.0.0",
     "@azure/identity": "^2.0.1",
-    "@azure-tools/test-recorder": "^1.0.0",
+    "@azure-tools/test-recorder": "^2.0.0",
+    "@azure-tools/test-credential": "^1.0.0",
     "mocha": "^7.1.1",
-    "cross-env": "^7.0.2"
+    "@types/chai": "^4.2.8",
+    "chai": "^4.2.0",
+    "cross-env": "^7.0.2",
+    "@types/node": "^14.0.0",
+    "@azure/dev-tool": "^1.0.0"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/databricks/arm-databricks",
   "repository": {
@@ -93,9 +98,8 @@
     "unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
     "unit-test:browser": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
-    "integration-test:browser": "echo skipped",
-    "docs": "echo skipped"
+    "integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
+    "integration-test:browser": "echo skipped"
   },
   "sideEffects": false,
   "//metadata": {

package/review/arm-databricks.api.md

@@ -122,9 +122,12 @@ export interface ErrorResponse {
 }
 
 // @public
-export type GroupIdInformation = Resource & {
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface GroupIdInformation extends Resource {
     properties: GroupIdInformationProperties;
-};
+}
 
 // @public
 export interface GroupIdInformationProperties {
@@ -138,129 +141,87 @@ export type KeySource = string;
 
 // @public
 export enum KnownCreatedByType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
 // @public
 export enum KnownCustomParameterType {
-    // (undocumented)
     Bool = "Bool",
-    // (undocumented)
     Object = "Object",
-    // (undocumented)
     String = "String"
 }
 
 // @public
 export enum KnownEncryptionKeySource {
-    // (undocumented)
     MicrosoftKeyvault = "Microsoft.Keyvault"
 }
 
 // @public
 export enum KnownKeySource {
-    // (undocumented)
     Default = "Default",
-    // (undocumented)
     MicrosoftKeyvault = "Microsoft.Keyvault"
 }
 
 // @public
 export enum KnownPeeringProvisioningState {
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 
 // @public
 export enum KnownPeeringState {
-    // (undocumented)
     Connected = "Connected",
-    // (undocumented)
     Disconnected = "Disconnected",
-    // (undocumented)
     Initiated = "Initiated"
 }
 
 // @public
 export enum KnownPrivateEndpointConnectionProvisioningState {
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 
 // @public
 export enum KnownPrivateLinkServiceConnectionStatus {
-    // (undocumented)
     Approved = "Approved",
-    // (undocumented)
     Disconnected = "Disconnected",
-    // (undocumented)
     Pending = "Pending",
-    // (undocumented)
     Rejected = "Rejected"
 }
 
 // @public
 export enum KnownProvisioningState {
-    // (undocumented)
     Accepted = "Accepted",
-    // (undocumented)
     Canceled = "Canceled",
-    // (undocumented)
     Created = "Created",
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleted = "Deleted",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Ready = "Ready",
-    // (undocumented)
     Running = "Running",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 
 // @public
 export enum KnownPublicNetworkAccess {
-    // (undocumented)
     Disabled = "Disabled",
-    // (undocumented)
     Enabled = "Enabled"
 }
 
 // @public
 export enum KnownRequiredNsgRules {
-    // (undocumented)
     AllRules = "AllRules",
-    // (undocumented)
     NoAzureDatabricksRules = "NoAzureDatabricksRules",
-    // (undocumented)
     NoAzureServiceRules = "NoAzureServiceRules"
 }
 
@@ -484,12 +445,12 @@ export interface SystemData {
 }
 
 // @public
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
+    location: string;
     tags?: {
         [propertyName: string]: string;
     };
-    location: string;
-};
+}
 
 // @public
 export interface VirtualNetworkPeering {
@@ -571,25 +532,25 @@ export interface VNetPeeringListByWorkspaceOptionalParams extends coreClient.Ope
 export type VNetPeeringListByWorkspaceResponse = VirtualNetworkPeeringList;
 
 // @public
-export type Workspace = TrackedResource & {
-    sku?: Sku;
-    readonly systemData?: SystemData;
-    managedResourceGroupId: string;
-    parameters?: WorkspaceCustomParameters;
-    readonly provisioningState?: ProvisioningState;
-    uiDefinitionUri?: string;
+export interface Workspace extends TrackedResource {
     authorizations?: WorkspaceProviderAuthorization[];
     createdBy?: CreatedBy;
-    updatedBy?: CreatedBy;
     readonly createdDateTime?: Date;
-    readonly workspaceId?: string;
-    readonly workspaceUrl?: string;
-    storageAccountIdentity?: ManagedIdentityConfiguration;
     encryption?: WorkspacePropertiesEncryption;
+    managedResourceGroupId: string;
+    parameters?: WorkspaceCustomParameters;
     readonly privateEndpointConnections?: PrivateEndpointConnection[];
+    readonly provisioningState?: ProvisioningState;
     publicNetworkAccess?: PublicNetworkAccess;
     requiredNsgRules?: RequiredNsgRules;
-};
+    sku?: Sku;
+    storageAccountIdentity?: ManagedIdentityConfiguration;
+    readonly systemData?: SystemData;
+    uiDefinitionUri?: string;
+    updatedBy?: CreatedBy;
+    readonly workspaceId?: string;
+    readonly workspaceUrl?: string;
+}
 
 // @public
 export interface WorkspaceCustomBooleanParameter {

package/src/azureDatabricksManagementClient.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 {
   WorkspacesImpl,
@@ -59,47 +64,53 @@ export class AzureDatabricksManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-databricks/3.0.0-beta.3`;
+    const packageDetails = `azsdk-js-arm-databricks/3.0.0-beta.4`;
     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;
@@ -115,6 +126,35 @@ export class AzureDatabricksManagementClient extends coreClient.ServiceClient {
       this
     );
     this.vNetPeering = new VNetPeeringImpl(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);
   }
 
   workspaces: Workspaces;

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { AzureDatabricksManagementClient } from "./azureDatabricksManagementClient";
 export * from "./operationsInterfaces";

package/src/models/index.ts

@@ -469,21 +469,21 @@ export interface VirtualNetworkPeeringList {
 }
 
 /** The resource model definition for a ARM tracked top level resource */
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
   /** Resource tags. */
   tags?: { [propertyName: string]: string };
   /** The geo-location where the resource lives */
   location: string;
-};
+}
 
 /** The group information for creating a private endpoint on a workspace */
-export type GroupIdInformation = Resource & {
+export interface GroupIdInformation extends Resource {
   /** The group id properties. */
   properties: GroupIdInformationProperties;
-};
+}
 
 /** Information about workspace. */
-export type Workspace = TrackedResource & {
+export interface Workspace extends TrackedResource {
   /** The SKU of the resource. */
   sku?: Sku;
   /**
@@ -536,12 +536,15 @@ export 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;
-};
+}
 
 /** Known values of {@link CustomParameterType} that the service accepts. */
 export enum KnownCustomParameterType {
+  /** Bool */
   Bool = "Bool",
+  /** Object */
   Object = "Object",
+  /** String */
   String = "String"
 }
 
@@ -558,7 +561,9 @@ export type CustomParameterType = string;
 
 /** Known values of {@link KeySource} that the service accepts. */
 export enum KnownKeySource {
+  /** Default */
   Default = "Default",
+  /** MicrosoftKeyvault */
   MicrosoftKeyvault = "Microsoft.Keyvault"
 }
 
@@ -574,16 +579,27 @@ export type KeySource = string;
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export 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"
 }
 
@@ -608,6 +624,7 @@ export type ProvisioningState = string;
 
 /** Known values of {@link EncryptionKeySource} that the service accepts. */
 export enum KnownEncryptionKeySource {
+  /** MicrosoftKeyvault */
   MicrosoftKeyvault = "Microsoft.Keyvault"
 }
 
@@ -622,9 +639,13 @@ export type EncryptionKeySource = string;
 
 /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
 export enum KnownPrivateLinkServiceConnectionStatus {
+  /** Pending */
   Pending = "Pending",
+  /** Approved */
   Approved = "Approved",
+  /** Rejected */
   Rejected = "Rejected",
+  /** Disconnected */
   Disconnected = "Disconnected"
 }
 
@@ -642,10 +663,15 @@ export type PrivateLinkServiceConnectionStatus = string;
 
 /** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
 export enum KnownPrivateEndpointConnectionProvisioningState {
+  /** Succeeded */
   Succeeded = "Succeeded",
+  /** Creating */
   Creating = "Creating",
+  /** Updating */
   Updating = "Updating",
+  /** Deleting */
   Deleting = "Deleting",
+  /** Failed */
   Failed = "Failed"
 }
 
@@ -664,7 +690,9 @@ export type PrivateEndpointConnectionProvisioningState = string;
 
 /** Known values of {@link PublicNetworkAccess} that the service accepts. */
 export enum KnownPublicNetworkAccess {
+  /** Enabled */
   Enabled = "Enabled",
+  /** Disabled */
   Disabled = "Disabled"
 }
 
@@ -680,8 +708,11 @@ export type PublicNetworkAccess = string;
 
 /** Known values of {@link RequiredNsgRules} that the service accepts. */
 export enum KnownRequiredNsgRules {
+  /** AllRules */
   AllRules = "AllRules",
+  /** NoAzureDatabricksRules */
   NoAzureDatabricksRules = "NoAzureDatabricksRules",
+  /** NoAzureServiceRules */
   NoAzureServiceRules = "NoAzureServiceRules"
 }
 
@@ -698,9 +729,13 @@ export type RequiredNsgRules = 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"
 }
 
@@ -718,8 +753,11 @@ export type CreatedByType = string;
 
 /** Known values of {@link PeeringState} that the service accepts. */
 export enum KnownPeeringState {
+  /** Initiated */
   Initiated = "Initiated",
+  /** Connected */
   Connected = "Connected",
+  /** Disconnected */
   Disconnected = "Disconnected"
 }
 
@@ -736,9 +774,13 @@ export type PeeringState = string;
 
 /** Known values of {@link PeeringProvisioningState} that the service accepts. */
 export enum KnownPeeringProvisioningState {
+  /** Succeeded */
   Succeeded = "Succeeded",
+  /** Updating */
   Updating = "Updating",
+  /** Deleting */
   Deleting = "Deleting",
+  /** Failed */
   Failed = "Failed"
 }
 

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<Operation[]> {
-    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;
     }
   }
 

package/src/operations/outboundNetworkDependenciesEndpoints.ts

@@ -32,7 +32,7 @@ export class OutboundNetworkDependenciesEndpointsImpl
   /**
    * 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.