arm-databricks-release (#16327)

Azure · Jul 9, 2021 · 35fc536 · 35fc536
1 parent 719cb86
commit 35fc536
Show file tree

Hide file tree

Showing 22 changed files with 3,322 additions and 425 deletions.
diff --git a/sdk/databricks/arm-databricks/LICENSE.txt b/sdk/databricks/arm-databricks/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Microsoft
+Copyright (c) 2021 Microsoft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/sdk/databricks/arm-databricks/README.md b/sdk/databricks/arm-databricks/README.md
@@ -1,93 +1,101 @@
-## Azure DatabricksClient SDK for JavaScript
+## Azure AzureDatabricksManagementClient SDK for JavaScript
 
-This package contains an isomorphic SDK for DatabricksClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for AzureDatabricksManagementClient.
 
 ### Currently supported environments
 
-- Node.js version 6.x.x or higher
-- Browser JavaScript
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- Latest versions of Safari, Chrome, Edge and Firefox.
 
-### How to Install
+### Prerequisites
 
+You must have an [Azure subscription](https://azure.microsoft.com/free/).
+
+### How to install
+
+To use this SDK in your project, you will need to install two packages.
+- `@azure/arm-databricks` that contains the client.
+- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
+
+Install both packages using the below command:
+```bash
+npm install --save @azure/arm-databricks @azure/identity
 ```
-npm install @azure/arm-databricks
-```
+> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
+If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.
 
 ### How to use
 
-#### nodejs - Authentication, client creation and get workspaces as an example written in TypeScript.
+- If you are writing a client side browser application,
+  - Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
+  - Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
+- If you are writing a server side application,
+  - [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
+  - Complete the set up steps required by the credential if any.
+  - Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.
 
-##### Install @azure/ms-rest-nodeauth
-
-```
-npm install @azure/ms-rest-nodeauth
-```
+In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
+Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
+#### nodejs - Authentication, client creation, and get workspaces as an example written in JavaScript.
 
 ##### Sample code
 
-```ts
-import * as msRest from "@azure/ms-rest-js";
-import * as msRestAzure from "@azure/ms-rest-azure-js";
-import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
-import { DatabricksClient, DatabricksModels, DatabricksMappers } from "@azure/arm-databricks";
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { AzureDatabricksManagementClient } = require("@azure/arm-databricks");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new DatabricksClient(creds, subscriptionId);
-  const resourceGroupName = "testresourceGroupName";
-  const workspaceName = "testworkspaceName";
-  client.workspaces.get(resourceGroupName, workspaceName).then((result) => {
-    console.log("The result is:");
-    console.log(result);
-  });
+// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
+// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
+const creds = new DefaultAzureCredential();
+const client = new AzureDatabricksManagementClient(creds, subscriptionId);
+const resourceGroupName = "testresourceGroupName";
+const workspaceName = "testworkspaceName";
+client.workspaces.get(resourceGroupName, workspaceName).then((result) => {
+  console.log("The result is:");
+  console.log(result);
 }).catch((err) => {
+  console.log("An error occurred:");
   console.error(err);
 });
 ```
 
-#### browser - Authentication, client creation and get workspaces as an example written in JavaScript.
+#### browser - Authentication, client creation, and get workspaces as an example written in JavaScript.
 
-##### Install @azure/ms-rest-browserauth
-
-```
-npm install @azure/ms-rest-browserauth
-```
+In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
+  - See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
+  - Note down the client Id from the previous step and use it in the browser sample below.
 
 ##### Sample code
 
-See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
-
 - index.html
+
 ```html
 <!DOCTYPE html>
 <html lang="en">
   <head>
     <title>@azure/arm-databricks sample</title>
-    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
     <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
-    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
+    <script src="node_modules/@azure/identity/dist/index.js"></script>
     <script src="node_modules/@azure/arm-databricks/dist/arm-databricks.js"></script>
     <script type="text/javascript">
       const subscriptionId = "<Subscription_Id>";
-      const authManager = new msAuth.AuthManager({
+      // Create credentials using the `@azure/identity` package.
+      // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
+      const credential = new InteractiveBrowserCredential(
+      {
         clientId: "<client id for your Azure AD app>",
         tenant: "<optional tenant for your organization>"
       });
-      authManager.finalizeLogin().then((res) => {
-        if (!res.isLoggedIn) {
-          // may cause redirects
-          authManager.login();
-        }
-        const client = new Azure.ArmDatabricks.DatabricksClient(res.creds, subscriptionId);
-        const resourceGroupName = "testresourceGroupName";
-        const workspaceName = "testworkspaceName";
-        client.workspaces.get(resourceGroupName, workspaceName).then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.ArmDatabricks.AzureDatabricksManagementClient(creds, subscriptionId);
+      const resourceGroupName = "testresourceGroupName";
+      const workspaceName = "testworkspaceName";
+      client.workspaces.get(resourceGroupName, workspaceName).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>
@@ -99,5 +107,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
-
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fdatabricks%2Farm-databricks%2FREADME.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/databricks/arm-databricks/README.png)
diff --git a/sdk/databricks/arm-databricks/package.json b/sdk/databricks/arm-databricks/package.json
@@ -1,12 +1,13 @@
 {
   "name": "@azure/arm-databricks",
   "author": "Microsoft Corporation",
-  "description": "DatabricksClient Library with typescript type definitions for node.js and browser.",
-  "version": "1.1.0",
+  "description": "AzureDatabricksManagementClient Library with typescript type definitions for node.js and browser.",
+  "version": "2.0.0",
   "dependencies": {
-    "@azure/ms-rest-azure-js": "^1.1.0",
-    "@azure/ms-rest-js": "^1.1.0",
-    "tslib": "^1.9.3"
+    "@azure/ms-rest-azure-js": "^2.1.0",
+    "@azure/ms-rest-js": "^2.2.0",
+    "@azure/core-auth": "^1.1.4",
+    "tslib": "^1.10.0"
   },
   "keywords": [
     "node",
@@ -17,21 +18,22 @@
   ],
   "license": "MIT",
   "main": "./dist/arm-databricks.js",
-  "module": "./esm/databricksClient.js",
-  "types": "./esm/databricksClient.d.ts",
+  "module": "./esm/azureDatabricksManagementClient.js",
+  "types": "./esm/azureDatabricksManagementClient.d.ts",
   "devDependencies": {
-    "typescript": "^3.1.1",
-    "rollup": "^0.66.2",
-    "rollup-plugin-node-resolve": "^3.4.0",
-    "uglify-js": "^3.4.9"
+    "typescript": "^3.6.0",
+    "rollup": "^1.18.0",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-sourcemaps": "^0.4.2",
+    "uglify-js": "^3.6.0"
   },
-  "homepage": "https://github.com/azure/azure-sdk-for-js/tree/main/sdk/databricks/arm-databricks",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/feature/v4/sdk/databricks/arm-databricks",
   "repository": {
     "type": "git",
-    "url": "https://github.com/azure/azure-sdk-for-js.git"
+    "url": "https://github.com/Azure/azure-sdk-for-js.git"
   },
   "bugs": {
-    "url": "https://github.com/azure/azure-sdk-for-js/issues"
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
   "files": [
     "dist/**/*.js",
@@ -43,6 +45,7 @@
     "esm/**/*.d.ts",
     "esm/**/*.d.ts.map",
     "src/**/*.ts",
+    "README.md",
     "rollup.config.js",
     "tsconfig.json"
   ],

diff --git a/sdk/databricks/arm-databricks/rollup.config.js b/sdk/databricks/arm-databricks/rollup.config.js
@@ -1,10 +1,16 @@
+import rollup from "rollup";
 import nodeResolve from "rollup-plugin-node-resolve";
+import sourcemaps from "rollup-plugin-sourcemaps";
+
 /**
- * @type {import('rollup').RollupFileOptions}
+ * @type {rollup.RollupFileOptions}
  */
 const config = {
-  input: './esm/databricksClient.js',
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
+  input: "./esm/azureDatabricksManagementClient.js",
+  external: [
+    "@azure/ms-rest-js",
+    "@azure/ms-rest-azure-js"
+  ],
   output: {
     file: "./dist/arm-databricks.js",
     format: "umd",
@@ -15,17 +21,17 @@ const config = {
       "@azure/ms-rest-azure-js": "msRestAzure"
     },
     banner: `/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
+ * 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.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */`
   },
   plugins: [
-    nodeResolve({ module: true })
+    nodeResolve({ mainFields: ['module', 'main'] }),
+    sourcemaps()
   ]
 };
+
 export default config;
diff --git a/sdk/databricks/arm-databricks/src/azureDatabricksManagementClient.ts b/sdk/databricks/arm-databricks/src/azureDatabricksManagementClient.ts
@@ -0,0 +1,55 @@
+/*
+ * 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.
+ */
+
+import * as msRest from "@azure/ms-rest-js";
+import { TokenCredential } from "@azure/core-auth";
+import * as Models from "./models";
+import * as Mappers from "./models/mappers";
+import * as operations from "./operations";
+import { AzureDatabricksManagementClientContext } from "./azureDatabricksManagementClientContext";
+
+
+class AzureDatabricksManagementClient extends AzureDatabricksManagementClientContext {
+  // Operation groups
+  workspaces: operations.Workspaces;
+  operations: operations.Operations;
+  privateLinkResources: operations.PrivateLinkResources;
+  privateEndpointConnections: operations.PrivateEndpointConnections;
+  vNetPeering: operations.VNetPeering;
+
+  /**
+   * Initializes a new instance of the AzureDatabricksManagementClient class.
+   * @param credentials Credentials needed for the client to connect to Azure. Credentials
+   * implementing the TokenCredential interface from the @azure/identity package are recommended. For
+   * more information about these credentials, see
+   * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
+   * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
+   * @azure/ms-rest-browserauth are also supported.
+   * @param subscriptionId The ID of the target subscription.
+   * @param [options] The parameter options
+   */
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AzureDatabricksManagementClientOptions) {
+    super(credentials, subscriptionId, options);
+    this.workspaces = new operations.Workspaces(this);
+    this.operations = new operations.Operations(this);
+    this.privateLinkResources = new operations.PrivateLinkResources(this);
+    this.privateEndpointConnections = new operations.PrivateEndpointConnections(this);
+    this.vNetPeering = new operations.VNetPeering(this);
+  }
+}
+
+// Operation Specifications
+
+export {
+  AzureDatabricksManagementClient,
+  AzureDatabricksManagementClientContext,
+  Models as AzureDatabricksManagementModels,
+  Mappers as AzureDatabricksManagementMappers
+};
+export * from "./operations";