[ReleasePR @azure/arm-security] New API version to Microsoft.Security 2021-11-01

sdk/security/arm-security/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 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

sdk/security/arm-security/README.md

@@ -1,92 +1,99 @@
 ## Azure SecurityCenter SDK for JavaScript
 
-This package contains an isomorphic SDK for SecurityCenter.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for SecurityCenter.
 
 ### 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-security` 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 @azure/arm-security
+npm install --save @azure/arm-security @azure/identity
 ```
+> **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 list complianceResults 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
-
-- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
-```bash
-npm install @azure/ms-rest-nodeauth@"^3.0.0"
-```
+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 list complianceResults as an example written in JavaScript.
 
 ##### Sample code
 
-```typescript
-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 { SecurityCenter, SecurityCenterModels, SecurityCenterMappers } from "@azure/arm-security";
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { SecurityCenter } = require("@azure/arm-security");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new SecurityCenter(creds, subscriptionId);
-  const scope = "testscope";
-  client.complianceResults.list(scope).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 SecurityCenter(creds, subscriptionId);
+const scope = "testscope";
+client.complianceResults.list(scope).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 list complianceResults as an example written in JavaScript.
+#### browser - Authentication, client creation, and list complianceResults as an example written in JavaScript.
 
-##### Install @azure/ms-rest-browserauth
-
-```bash
-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-security 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-security/dist/arm-security.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.ArmSecurity.SecurityCenter(res.creds, subscriptionId);
-        const scope = "testscope";
-        client.complianceResults.list(scope).then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.ArmSecurity.SecurityCenter(creds, subscriptionId);
+      const scope = "testscope";
+      client.complianceResults.list(scope).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>

sdk/security/arm-security/package.json

@@ -4,8 +4,9 @@
   "description": "SecurityCenter Library with typescript type definitions for node.js and browser.",
   "version": "2.0.0",
   "dependencies": {
-    "@azure/ms-rest-azure-js": "^2.0.1",
-    "@azure/ms-rest-js": "^2.0.4",
+    "@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": [
@@ -20,7 +21,7 @@
   "module": "./esm/securityCenter.js",
   "types": "./esm/securityCenter.d.ts",
   "devDependencies": {
-    "typescript": "^3.5.3",
+    "typescript": "^3.6.0",
     "rollup": "^1.18.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.4.2",

sdk/security/arm-security/rollup.config.js

@@ -21,8 +21,8 @@ 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.

sdk/security/arm-security/src/models/adaptiveApplicationControlsMappers.ts

@@ -1,16 +1,16 @@
 /*
- * 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.
  */
 
 export {
   discriminators,
-  AppWhitelistingGroup,
-  AppWhitelistingGroups,
-  AppWhitelistingIssueSummary,
+  AdaptiveApplicationControlGroup,
+  AdaptiveApplicationControlGroups,
+  AdaptiveApplicationControlIssueSummary,
   CloudError,
   PathRecommendation,
   ProtectionMode,

sdk/security/arm-security/src/models/adaptiveNetworkHardeningsMappers.ts

@@ -1,6 +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 regenerated.
@@ -15,63 +15,101 @@ export {
   AdditionalData,
   AdvancedThreatProtectionSetting,
   Alert,
-  AlertConfidenceReason,
   AlertEntity,
   AlertsSuppressionRule,
+  AlertSyncSettings,
   AllowlistCustomAlertRule,
   AmqpC2DMessagesNotInAllowedRange,
   AmqpC2DRejectedMessagesNotInAllowedRange,
   AmqpD2CMessagesNotInAllowedRange,
   AscLocation,
   AssessmentLinks,
   AssessmentStatus,
+  AuthenticationDetailsProperties,
   AutoProvisioningSetting,
+  AwAssumeRoleAuthenticationDetailsProperties,
+  AwsCredsAuthenticationDetailsProperties,
   AzureResourceDetails,
+  AzureResourceIdentifier,
   AzureResourceLink,
+  Baseline,
+  BaselineAdjustedResult,
   BaseResource,
+  BenchmarkReference,
   CloudError,
   Compliance,
   ComplianceResult,
   ComplianceSegment,
+  ConnectionFromIpNotAllowed,
   ConnectionToIpNotAllowed,
+  ConnectorSetting,
   ContainerRegistryVulnerabilityProperties,
   CustomAlertRule,
   CVE,
   CVSS,
   DataExportSettings,
   DenylistCustomAlertRule,
+  Device,
   DeviceSecurityGroup,
   DirectMethodInvokesNotInAllowedRange,
   EffectiveNetworkSecurityGroups,
   FailedLocalLoginsNotInAllowedRange,
   FileUploadsNotInAllowedRange,
+  Firmware,
+  GcpCredentialsDetailsProperties,
   HttpC2DMessagesNotInAllowedRange,
   HttpC2DRejectedMessagesNotInAllowedRange,
   HttpD2CMessagesNotInAllowedRange,
+  HybridComputeSettingsProperties,
   InformationProtectionKeyword,
   InformationProtectionPolicy,
   InformationType,
+  IngestionSetting,
+  IotAlertModel,
+  IotAlertType,
+  IotDefenderSettingsModel,
+  IotRecommendationModel,
+  IotRecommendationType,
   IoTSecurityAlertedDevice,
   IoTSecurityDeviceAlert,
   IoTSecurityDeviceRecommendation,
   IoTSecuritySolutionAnalyticsModel,
   IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsItem,
+  IotSensorsModel,
   IoTSeverityMetrics,
+  IotSitesModel,
+  IpAddress,
   ListCustomAlertRule,
   LocalUserNotAllowed,
+  LogAnalyticsIdentifier,
+  MacAddress,
   MqttC2DMessagesNotInAllowedRange,
   MqttC2DRejectedMessagesNotInAllowedRange,
   MqttD2CMessagesNotInAllowedRange,
+  NetworkInterface,
+  OnPremiseIotSensor,
   OnPremiseResourceDetails,
+  OnPremiseSqlResourceDetails,
   Pricing,
   ProcessNotAllowed,
+  Protocol1,
+  ProxyServerProperties,
+  QueryCheck,
   QueuePurgesNotInAllowedRange,
   RegulatoryComplianceAssessment,
   RegulatoryComplianceControl,
   RegulatoryComplianceStandard,
+  Remediation,
   Resource,
   ResourceDetails,
+  ResourceIdentifier,
   Rule,
+  RuleResults,
+  RuleResultsProperties,
+  Scan,
+  ScanProperties,
+  ScanResult,
+  ScanResultProperties,
   ScopeElement,
   SecureScoreControlDefinitionItem,
   SecureScoreControlDefinitionSource,
@@ -87,17 +125,21 @@ export {
   SecurityTask,
   SecurityTaskParameters,
   SensitivityLabel,
+  Sensor,
   ServerVulnerabilityAssessment,
   ServerVulnerabilityProperties,
+  ServicePrincipalProperties,
   Setting,
-  SettingResource,
+  Site,
+  Software,
   SqlServerVulnerabilityProperties,
   SubAssessmentStatus,
   SuppressionAlertsScope,
   ThresholdCustomAlertRule,
   TimeWindowCustomAlertRule,
   TwinUpdatesNotInAllowedRange,
   UnauthorizedOperationsNotInAllowedRange,
+  VaRule,
   VendorReference,
   WorkspaceSetting
 } from "../models/mappers";