@azure/arm-features 3.0.0-beta.1 → 3.0.0

package/CHANGELOG.md

@@ -1,16 +1,11 @@
 # Release History
+    
+## 3.0.0 (2021-12-07)
 
-## 3.0.0-beta.1 (2021-10-09)
+The package of @azure/arm-features is using our next generation design principles since version 3.0.0, which contains breaking changes.
 
-This is the first preview for the new version of the `@azure/arm-features` package that follows the new [guidelines for TypeScript SDKs](https://azure.github.io/azure-sdk/typescript_introduction.html) for Azure services.
+To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog).
 
-While this package remains auto generated, the SDK generator itself has undergone changes to comply with the above guidelines in order to generate packages that are idiomatic to the JavaScript/TypeScript ecosystem and consistent with other packages for Azure services. For more on this, please see [State of the Azure SDK 2021](https://devblogs.microsoft.com/azure-sdk/state-of-the-azure-sdk-2021/).
+To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).
 
-Please note that this version has breaking changes, all of which were made after careful consideration during the authoring of the guidelines and user studies.
-
-**Noteworthy changes and features**
-- Authentication: The packages `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` are no longer supported. Use package [@azure/identity](https://www.npmjs.com/package/@azure/identity) instead. Select a credential from Azure Identity examples based on the authentication method of your choice.
-- Callbacks: Method overloads that used callbacks have been removed and the use of promises is encouraged instead.
-- List operations now return an iterable result that follows the `PagedAsyncIterableIterator` interface as opposed to the previous model where you had to make a new request using the link to the next page.
-- Long running operations i.e. the Lro related object returned by methods whose names started with `begin`, now uses `pollUntilDone` to check whether the request is finished, instead of `pollUntilFinished`. To get the final result, use the corresponding method that will have the suffix `AndWait`.
-- The SDK only supports ECMAScript 2015 (ES6) and beyond, all projects that referenced this SDK should be upgraded to use ES6.
+To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart).

package/README.md

@@ -4,7 +4,7 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users. Resource providers typically use this mechanism to provide public/private preview for new features prior to making them generally available. Users need to explicitly register for AFEC features to get access to such functionality.
 
-[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/features/arm-features) |
+[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/features/arm-features) |
 [Package (NPM)](https://www.npmjs.com/package/@azure/arm-features) |
 [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-features) |
 [Samples](https://github.com/Azure-Samples/azure-samples-js-management)
@@ -33,17 +33,19 @@ npm install @azure/arm-features
 To create a client object to access the Azure Feature API, you will need the `endpoint` of your Azure Feature resource and a `credential`. The Azure Feature client can use Azure Active Directory credentials to authenticate.
 You can find the endpoint for your Azure Feature resource in the [Azure Portal][azure_portal].
 
-#### Using an Azure Active Directory Credential
+You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
 
-You can authenticate with Azure Active Directory using the [Azure Identity library][azure_identity]. To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
+To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
 
 ```bash
 npm install @azure/identity
 ```
 
-You will also need to register a new AAD application and grant access to Azure Feature by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
+You will also need to **register a new AAD application and grant access to Azure Feature** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
 Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
 
+For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
+
 ```javascript
 const { FeatureClient } = require("@azure/arm-features");
 const { DefaultAzureCredential } = require("@azure/identity");
@@ -51,6 +53,10 @@ const subscriptionId = "00000000-0000-0000-0000-000000000000";
 const client = new FeatureClient(new DefaultAzureCredential(), subscriptionId);
 ```
 
+
+### JavaScript Bundle
+To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
+
 ## Key concepts
 
 ### FeatureClient
@@ -64,11 +70,11 @@ const client = new FeatureClient(new DefaultAzureCredential(), subscriptionId);
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
 ```javascript
-import { setLogLevel } from "@azure/logger";
+const { setLogLevel } = require("@azure/logger");
 setLogLevel("info");
 ```
 
-For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 ## Next steps
 
@@ -76,7 +82,7 @@ Please take a look at the [samples](https://github.com/Azure-Samples/azure-sampl
 
 ## Contributing
 
-If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
 
 ## Related projects
 
@@ -88,5 +94,5 @@ If you'd like to contribute to this library, please read the [contributing guide
 [azure_sub]: https://azure.microsoft.com/free/
 [azure_sub]: https://azure.microsoft.com/free/
 [azure_portal]: https://portal.azure.com
-[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity
-[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
+[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
+[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

package/dist/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var tslib = require('tslib');
 var coreClient = require('@azure/core-client');
-require('@azure/core-paging');
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -230,35 +229,6 @@ const FeatureProperties = {
         }
     }
 };
-const ProxyResource = {
-    type: {
-        name: "Composite",
-        className: "ProxyResource",
-        modelProperties: {
-            id: {
-                serializedName: "id",
-                readOnly: true,
-                type: {
-                    name: "String"
-                }
-            },
-            name: {
-                serializedName: "name",
-                readOnly: true,
-                type: {
-                    name: "String"
-                }
-            },
-            type: {
-                serializedName: "type",
-                readOnly: true,
-                type: {
-                    name: "String"
-                }
-            }
-        }
-    }
-};
 const SubscriptionFeatureRegistrationProperties = {
     type: {
         name: "Composite",
@@ -351,6 +321,7 @@ const SubscriptionFeatureRegistrationProperties = {
                 }
             },
             shouldFeatureDisplayInPortal: {
+                defaultValue: false,
                 serializedName: "shouldFeatureDisplayInPortal",
                 type: {
                     name: "Boolean"
@@ -411,6 +382,35 @@ const AuthorizationProfile = {
         }
     }
 };
+const ProxyResource = {
+    type: {
+        name: "Composite",
+        className: "ProxyResource",
+        modelProperties: {
+            id: {
+                serializedName: "id",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            name: {
+                serializedName: "name",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            type: {
+                serializedName: "type",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const SubscriptionFeatureRegistrationList = {
     type: {
         name: "Composite",
@@ -461,9 +461,9 @@ var Mappers = /*#__PURE__*/Object.freeze({
     FeatureOperationsListResult: FeatureOperationsListResult,
     FeatureResult: FeatureResult,
     FeatureProperties: FeatureProperties,
-    ProxyResource: ProxyResource,
     SubscriptionFeatureRegistrationProperties: SubscriptionFeatureRegistrationProperties,
     AuthorizationProfile: AuthorizationProfile,
+    ProxyResource: ProxyResource,
     SubscriptionFeatureRegistrationList: SubscriptionFeatureRegistrationList,
     SubscriptionFeatureRegistration: SubscriptionFeatureRegistration
 });
@@ -594,7 +594,7 @@ const subscriptionFeatureRegistrationType = {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 /// <reference lib="esnext.asynciterable" />
-/** Class representing a Features. */
+/** Class containing Features operations. */
 class FeaturesImpl {
     /**
      * Initialize a new instance of the class Features class.
@@ -913,7 +913,7 @@ const listNextOperationSpec = {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 /// <reference lib="esnext.asynciterable" />
-/** Class representing a SubscriptionFeatureRegistrations. */
+/** Class containing SubscriptionFeatureRegistrations operations. */
 class SubscriptionFeatureRegistrationsImpl {
     /**
      * Initialize a new instance of the class SubscriptionFeatureRegistrations class.
@@ -1230,9 +1230,10 @@ const listAllBySubscriptionNextOperationSpec = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-class FeatureClientContext extends coreClient.ServiceClient {
+/// <reference lib="esnext.asynciterable" />
+class FeatureClient extends coreClient.ServiceClient {
     /**
-     * Initializes a new instance of the FeatureClientContext class.
+     * Initializes a new instance of the FeatureClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
      * @param subscriptionId The Azure subscription ID.
      * @param options The parameter options
@@ -1252,7 +1253,7 @@ class FeatureClientContext extends coreClient.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-features/3.0.0-beta.1`;
+        const packageDetails = `azsdk-js-arm-features/3.0.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1268,26 +1269,6 @@ class FeatureClientContext extends coreClient.ServiceClient {
         // Assigning values to Constant parameters
         this.$host = options.$host || "https://management.azure.com";
         this.apiVersion = options.apiVersion || "2021-07-01";
-    }
-}
-
-/*
- * 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.
- */
-/// <reference lib="esnext.asynciterable" />
-class FeatureClient extends FeatureClientContext {
-    /**
-     * Initializes a new instance of the FeatureClient class.
-     * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId The Azure subscription ID.
-     * @param options The parameter options
-     */
-    constructor(credentials, subscriptionId, options) {
-        super(credentials, subscriptionId, options);
         this.features = new FeaturesImpl(this);
         this.subscriptionFeatureRegistrations = new SubscriptionFeatureRegistrationsImpl(this);
     }
@@ -1391,5 +1372,4 @@ const listOperationsNextOperationSpec = {
 };
 
 exports.FeatureClient = FeatureClient;
-exports.FeatureClientContext = FeatureClientContext;
 //# sourceMappingURL=index.js.map