@azure/arm-links 2.0.0-beta.1 → 2.0.0

package/CHANGELOG.md

@@ -1,16 +1,11 @@
 # Release History
+    
+## 2.0.0 (2021-12-07)
 
-## 2.0.0-beta.1 (2021-10-09)
+The package of @azure/arm-links is using our next generation design principles since version 2.0.0, which contains breaking changes.
 
-This is the first preview for the new version of the `@azure/arm-links` 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 resources can be linked together to form logical relationships. You can establish links between resources belonging to different resource groups. However, all the linked resources must belong to the same subscription. Each resource can be linked to 50 other resources. If any of the linked resources are deleted or moved, the link owner must clean up the remaining link.
 
-[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/links/arm-links) |
+[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/links/arm-links) |
 [Package (NPM)](https://www.npmjs.com/package/@azure/arm-links) |
 [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-links) |
 [Samples](https://github.com/Azure-Samples/azure-samples-js-management)
@@ -33,17 +33,19 @@ npm install @azure/arm-links
 To create a client object to access the Azure ManagementLink API, you will need the `endpoint` of your Azure ManagementLink resource and a `credential`. The Azure ManagementLink client can use Azure Active Directory credentials to authenticate.
 You can find the endpoint for your Azure ManagementLink 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 ManagementLink 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 ManagementLink** 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 { ManagementLinkClient } = require("@azure/arm-links");
 const { DefaultAzureCredential } = require("@azure/identity");
@@ -51,6 +53,10 @@ const subscriptionId = "00000000-0000-0000-0000-000000000000";
 const client = new ManagementLinkClient(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
 
 ### ManagementLinkClient
@@ -64,11 +70,11 @@ const client = new ManagementLinkClient(new DefaultAzureCredential(), subscripti
 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

@@ -2,9 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var tslib = require('tslib');
-require('@azure/core-paging');
 var coreClient = require('@azure/core-client');
+var tslib = require('tslib');
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -339,7 +338,7 @@ const filter1 = {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 /// <reference lib="esnext.asynciterable" />
-/** Class representing a Operations. */
+/** Class containing Operations operations. */
 class OperationsImpl {
     /**
      * Initialize a new instance of the class Operations class.
@@ -396,55 +395,6 @@ class OperationsImpl {
             }
         });
     }
-    /**
-     * ListNext
-     * @param nextLink The nextLink from the previous successful call to the List method.
-     * @param options The options parameters.
-     */
-    listNext(nextLink, options) {
-        const iter = this.listNextPagingAll(nextLink, options);
-        return {
-            next() {
-                return iter.next();
-            },
-            [Symbol.asyncIterator]() {
-                return this;
-            },
-            byPage: () => {
-                return this.listNextPagingPage(nextLink, options);
-            }
-        };
-    }
-    listNextPagingPage(nextLink, options) {
-        return tslib.__asyncGenerator(this, arguments, function* listNextPagingPage_1() {
-            let result = yield tslib.__await(this._listNext(nextLink, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
-            while (continuationToken) {
-                result = yield tslib.__await(this._listNextNext(continuationToken, options));
-                continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
-            }
-        });
-    }
-    listNextPagingAll(nextLink, options) {
-        return tslib.__asyncGenerator(this, arguments, function* listNextPagingAll_1() {
-            var e_2, _a;
-            try {
-                for (var _b = tslib.__asyncValues(this.listNextPagingPage(nextLink, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
-                    const page = _c.value;
-                    yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
-                }
-            }
-            catch (e_2_1) { e_2 = { error: e_2_1 }; }
-            finally {
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
-                }
-                finally { if (e_2) throw e_2.error; }
-            }
-        });
-    }
     /**
      * Lists all of the available Microsoft.Resources REST API operations.
      * @param options The options parameters.
@@ -460,14 +410,6 @@ class OperationsImpl {
     _listNext(nextLink, options) {
         return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec);
     }
-    /**
-     * ListNextNext
-     * @param nextLink The nextLink from the previous successful call to the ListNext method.
-     * @param options The options parameters.
-     */
-    _listNextNext(nextLink, options) {
-        return this.client.sendOperationRequest({ nextLink, options }, listNextNextOperationSpec);
-    }
 }
 // Operation Specifications
 const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
@@ -497,19 +439,6 @@ const listNextOperationSpec = {
     headerParameters: [accept],
     serializer
 };
-const listNextNextOperationSpec = {
-    path: "{nextLink}",
-    httpMethod: "GET",
-    responses: {
-        200: {
-            bodyMapper: OperationListResult
-        }
-    },
-    queryParameters: [apiVersion],
-    urlParameters: [$host, nextLink],
-    headerParameters: [accept],
-    serializer
-};
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -519,7 +448,7 @@ const listNextNextOperationSpec = {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 /// <reference lib="esnext.asynciterable" />
-/** Class representing a ResourceLinks. */
+/** Class containing ResourceLinks operations. */
 class ResourceLinksImpl {
     /**
      * Initialize a new instance of the class ResourceLinks class.
@@ -627,107 +556,6 @@ class ResourceLinksImpl {
             }
         });
     }
-    /**
-     * ListAtSubscriptionNext
-     * @param nextLink The nextLink from the previous successful call to the ListAtSubscription method.
-     * @param options The options parameters.
-     */
-    listAtSubscriptionNext(nextLink, options) {
-        const iter = this.listAtSubscriptionNextPagingAll(nextLink, options);
-        return {
-            next() {
-                return iter.next();
-            },
-            [Symbol.asyncIterator]() {
-                return this;
-            },
-            byPage: () => {
-                return this.listAtSubscriptionNextPagingPage(nextLink, options);
-            }
-        };
-    }
-    listAtSubscriptionNextPagingPage(nextLink, options) {
-        return tslib.__asyncGenerator(this, arguments, function* listAtSubscriptionNextPagingPage_1() {
-            let result = yield tslib.__await(this._listAtSubscriptionNext(nextLink, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
-            while (continuationToken) {
-                result = yield tslib.__await(this._listAtSubscriptionNextNext(continuationToken, options));
-                continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
-            }
-        });
-    }
-    listAtSubscriptionNextPagingAll(nextLink, options) {
-        return tslib.__asyncGenerator(this, arguments, function* listAtSubscriptionNextPagingAll_1() {
-            var e_3, _a;
-            try {
-                for (var _b = tslib.__asyncValues(this.listAtSubscriptionNextPagingPage(nextLink, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
-                    const page = _c.value;
-                    yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
-                }
-            }
-            catch (e_3_1) { e_3 = { error: e_3_1 }; }
-            finally {
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
-                }
-                finally { if (e_3) throw e_3.error; }
-            }
-        });
-    }
-    /**
-     * ListAtSourceScopeNext
-     * @param scope The fully qualified ID of the scope for getting the resource links. For example, to
-     *              list resource links at and under a resource group, set the scope to
-     *              /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup.
-     * @param nextLink The nextLink from the previous successful call to the ListAtSourceScope method.
-     * @param options The options parameters.
-     */
-    listAtSourceScopeNext(scope, nextLink, options) {
-        const iter = this.listAtSourceScopeNextPagingAll(scope, nextLink, options);
-        return {
-            next() {
-                return iter.next();
-            },
-            [Symbol.asyncIterator]() {
-                return this;
-            },
-            byPage: () => {
-                return this.listAtSourceScopeNextPagingPage(scope, nextLink, options);
-            }
-        };
-    }
-    listAtSourceScopeNextPagingPage(scope, nextLink, options) {
-        return tslib.__asyncGenerator(this, arguments, function* listAtSourceScopeNextPagingPage_1() {
-            let result = yield tslib.__await(this._listAtSourceScopeNext(scope, nextLink, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
-            while (continuationToken) {
-                result = yield tslib.__await(this._listAtSourceScopeNextNext(scope, continuationToken, options));
-                continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
-            }
-        });
-    }
-    listAtSourceScopeNextPagingAll(scope, nextLink, options) {
-        return tslib.__asyncGenerator(this, arguments, function* listAtSourceScopeNextPagingAll_1() {
-            var e_4, _a;
-            try {
-                for (var _b = tslib.__asyncValues(this.listAtSourceScopeNextPagingPage(scope, nextLink, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
-                    const page = _c.value;
-                    yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
-                }
-            }
-            catch (e_4_1) { e_4 = { error: e_4_1 }; }
-            finally {
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
-                }
-                finally { if (e_4) throw e_4.error; }
-            }
-        });
-    }
     /**
      * Deletes a resource link with the specified ID.
      * @param linkId The fully qualified ID of the resource link. Use the format,
@@ -796,25 +624,6 @@ class ResourceLinksImpl {
     _listAtSourceScopeNext(scope, nextLink, options) {
         return this.client.sendOperationRequest({ scope, nextLink, options }, listAtSourceScopeNextOperationSpec);
     }
-    /**
-     * ListAtSubscriptionNextNext
-     * @param nextLink The nextLink from the previous successful call to the ListAtSubscriptionNext method.
-     * @param options The options parameters.
-     */
-    _listAtSubscriptionNextNext(nextLink, options) {
-        return this.client.sendOperationRequest({ nextLink, options }, listAtSubscriptionNextNextOperationSpec);
-    }
-    /**
-     * ListAtSourceScopeNextNext
-     * @param scope The fully qualified ID of the scope for getting the resource links. For example, to
-     *              list resource links at and under a resource group, set the scope to
-     *              /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup.
-     * @param nextLink The nextLink from the previous successful call to the ListAtSourceScopeNext method.
-     * @param options The options parameters.
-     */
-    _listAtSourceScopeNextNext(scope, nextLink, options) {
-        return this.client.sendOperationRequest({ scope, nextLink, options }, listAtSourceScopeNextNextOperationSpec);
-    }
 }
 // Operation Specifications
 const serializer$1 = coreClient.createSerializer(Mappers, /* isXml */ false);
@@ -913,36 +722,6 @@ const listAtSourceScopeNextOperationSpec = {
     headerParameters: [accept],
     serializer: serializer$1
 };
-const listAtSubscriptionNextNextOperationSpec = {
-    path: "{nextLink}",
-    httpMethod: "GET",
-    responses: {
-        200: {
-            bodyMapper: ResourceLinkResult
-        }
-    },
-    queryParameters: [apiVersion, filter],
-    urlParameters: [
-        $host,
-        nextLink,
-        subscriptionId
-    ],
-    headerParameters: [accept],
-    serializer: serializer$1
-};
-const listAtSourceScopeNextNextOperationSpec = {
-    path: "{nextLink}",
-    httpMethod: "GET",
-    responses: {
-        200: {
-            bodyMapper: ResourceLinkResult
-        }
-    },
-    queryParameters: [apiVersion, filter1],
-    urlParameters: [$host, nextLink, scope],
-    headerParameters: [accept],
-    serializer: serializer$1
-};
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -951,9 +730,9 @@ const listAtSourceScopeNextNextOperationSpec = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-class ManagementLinkClientContext extends coreClient.ServiceClient {
+class ManagementLinkClient extends coreClient.ServiceClient {
     /**
-     * Initializes a new instance of the ManagementLinkClientContext class.
+     * Initializes a new instance of the ManagementLinkClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
      * @param subscriptionId The ID of the target subscription.
      * @param options The parameter options
@@ -973,7 +752,7 @@ class ManagementLinkClientContext extends coreClient.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-links/2.0.0-beta.1`;
+        const packageDetails = `azsdk-js-arm-links/2.0.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -989,30 +768,10 @@ class ManagementLinkClientContext extends coreClient.ServiceClient {
         // Assigning values to Constant parameters
         this.$host = options.$host || "https://management.azure.com";
         this.apiVersion = options.apiVersion || "2016-09-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.
- */
-class ManagementLinkClient extends ManagementLinkClientContext {
-    /**
-     * Initializes a new instance of the ManagementLinkClient class.
-     * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId The ID of the target subscription.
-     * @param options The parameter options
-     */
-    constructor(credentials, subscriptionId, options) {
-        super(credentials, subscriptionId, options);
         this.operations = new OperationsImpl(this);
         this.resourceLinks = new ResourceLinksImpl(this);
     }
 }
 
 exports.ManagementLinkClient = ManagementLinkClient;
-exports.ManagementLinkClientContext = ManagementLinkClientContext;
 //# sourceMappingURL=index.js.map