CodeGen from PR 14514 in Azure/azure-rest-api-specs

Merge fe2c2cc08c9c95d0ccdbf7fc030266afbac3c9ae into 61e7148e9592c5efc95e5c16a5bb4f2dc26d6de0
AzureSDKAutomation · Jun 15, 2021 · c08926e · c08926e
1 parent d738b3d
commit c08926e
Show file tree

Hide file tree

Showing 15 changed files with 2,266 additions and 185 deletions.
diff --git a/sdk/operationalinsights/loganalytics/LICENSE.txt b/sdk/operationalinsights/loganalytics/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/operationalinsights/loganalytics/README.md b/sdk/operationalinsights/loganalytics/README.md
@@ -1,99 +1,97 @@
 ## An isomorphic javascript sdk for - LogAnalyticsClient
 
-This package contains an isomorphic SDK for LogAnalyticsClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for LogAnalyticsClient.
 
 ### 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/loganalytics` 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/loganalytics @azure/identity
 ```
-npm install @azure/loganalytics
-```
+> **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 execute query 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 metadata as an example written in JavaScript.
 
 ##### Sample code
 
-```ts
-import * as msRest from "@azure/ms-rest-js";
-import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
-import { LogAnalyticsClient, LogAnalyticsModels, LogAnalyticsMappers } from "@azure/loganalytics";
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { LogAnalyticsClient } = require("@azure/loganalytics");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new LogAnalyticsClient(creds, subscriptionId);
-  const workspaceId = "testworkspaceId";
-  const body: LogAnalyticsModels.QueryBody = {
-    query: "testquery",
-    timespan: "testtimespan",
-    workspaces: ["testworkspaces"]
-  };
-  client.query.execute(workspaceId, body).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 LogAnalyticsClient(creds, subscriptionId);
+const workspaceId = "testworkspaceId";
+client.metadata.get(workspaceId).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 execute query as an example written in JavaScript.
+#### browser - Authentication, client creation, and get metadata 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/loganalytics sample</title>
-    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
-    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
     <script src="node_modules/@azure/loganalytics/dist/loganalytics.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.Loganalytics.LogAnalyticsClient(res.creds, subscriptionId);
-        const workspaceId = "testworkspaceId";
-        const body = {
-          query: "testquery",
-          timespan: "testtimespan",
-          workspaces: ["testworkspaces"]
-        };
-        client.query.execute(workspaceId, body).then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.Loganalytics.LogAnalyticsClient(creds, subscriptionId);
+      const workspaceId = "testworkspaceId";
+      client.metadata.get(workspaceId).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>
@@ -105,5 +103,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%2Foperationalinsights%2Floganalytics%2FREADME.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/operationalinsights/loganalytics/README.png)
diff --git a/sdk/operationalinsights/loganalytics/package.json b/sdk/operationalinsights/loganalytics/package.json
@@ -4,8 +4,9 @@
   "description": "LogAnalyticsClient Library with typescript type definitions for node.js and browser.",
   "version": "0.2.0",
   "dependencies": {
-    "@azure/ms-rest-js": "^1.1.0",
-    "tslib": "^1.9.3"
+    "@azure/ms-rest-js": "^2.2.0",
+    "@azure/core-auth": "^1.1.4",
+    "tslib": "^1.10.0"
   },
   "keywords": [
     "node",
@@ -19,18 +20,19 @@
   "module": "./esm/logAnalyticsClient.js",
   "types": "./esm/logAnalyticsClient.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/master/sdk/operationalinsights/loganalytics",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/operationalinsights/loganalytics",
   "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",
@@ -42,6 +44,7 @@
     "esm/**/*.d.ts",
     "esm/**/*.d.ts.map",
     "src/**/*.ts",
+    "README.md",
     "rollup.config.js",
     "tsconfig.json"
   ],

diff --git a/sdk/operationalinsights/loganalytics/rollup.config.js b/sdk/operationalinsights/loganalytics/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/logAnalyticsClient.js',
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
+  input: "./esm/logAnalyticsClient.js",
+  external: [
+    "@azure/ms-rest-js",
+    "@azure/ms-rest-azure-js"
+  ],
   output: {
     file: "./dist/loganalytics.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/operationalinsights/loganalytics/src/logAnalyticsClient.ts b/sdk/operationalinsights/loganalytics/src/logAnalyticsClient.ts
@@ -1,7 +1,6 @@
 /*
- * 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
@@ -17,15 +16,22 @@ import { LogAnalyticsClientContext } from "./logAnalyticsClientContext";
 class LogAnalyticsClient extends LogAnalyticsClientContext {
   // Operation groups
   query: operations.Query;
+  metadata: operations.Metadata;
 
   /**
    * Initializes a new instance of the LogAnalyticsClient class.
    * @param credentials Subscription credentials which uniquely identify client subscription.
+   * 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 [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, options?: Models.LogAnalyticsClientOptions) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, options?: Models.LogAnalyticsClientOptions) {
     super(credentials, options);
     this.query = new operations.Query(this);
+    this.metadata = new operations.Metadata(this);
   }
 }
 

diff --git a/sdk/operationalinsights/loganalytics/src/logAnalyticsClientContext.ts b/sdk/operationalinsights/loganalytics/src/logAnalyticsClientContext.ts
@@ -1,7 +1,6 @@
 /*
- * 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
@@ -12,34 +11,39 @@ import * as msRest from "@azure/ms-rest-js";
 import * as Models from "./models";
 
 const packageName = "@azure/loganalytics";
-const packageVersion = "0.1.0";
+const packageVersion = "0.2.0";
 
 export class LogAnalyticsClientContext extends msRest.ServiceClient {
-  credentials: msRest.ServiceClientCredentials;
+  credentials: msRest.ServiceClientCredentials | TokenCredential;
 
   /**
    * Initializes a new instance of the LogAnalyticsClientContext class.
    * @param credentials Subscription credentials which uniquely identify client subscription.
+   * 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 [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, options?: Models.LogAnalyticsClientOptions) {
-    if (credentials === null || credentials === undefined) {
-      throw new Error('\'credentials\' cannot be null.');
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, options?: Models.LogAnalyticsClientOptions) {
+    if (credentials == undefined) {
+      throw new Error("'credentials' cannot be null.");
     }
 
     if (!options) {
       options = {};
     }
-    if(!options.userAgent) {
+
+    if (!options.userAgent) {
       const defaultUserAgent = msRest.getDefaultUserAgentValue();
       options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
     }
 
     super(credentials, options);
 
-    this.baseUri = options.baseUri || this.baseUri || "https://api.loganalytics.io";
+    this.baseUri = options.baseUri || this.baseUri || "https://api.loganalytics.io/v1";
     this.requestContentType = "application/json; charset=utf-8";
     this.credentials = credentials;
-
   }
 }