@azure/arm-portal 1.0.0-beta.3 → 1.0.0-beta.5

package/CHANGELOG.md

@@ -1,12 +1,30 @@
-## Release History
+# Release History
 
-### 1.0.0-beta.3 (2022-04-28)
+## 1.0.0-beta.5 (2023-02-02)
+
+**Features**
+
+  - Exposes `getContinuationToken` helper function to extract continuation token
+
+**Bugs Fixed**
+
+  - A series of small bug fixs relevant to authentication and apiVersion policy
+
+## 1.0.0-beta.4 (2022-07-08)
+    
+**Features**
+
+  - Added Interface Configuration
+  - Added Interface MarkdownPartMetadata
+  - Added Interface ProxyResource
+    
+## 1.0.0-beta.3 (2022-04-28)
 
 **Features**
 
   - Bug fix
 
-### 1.0.0-beta.2 (2021-11-30)
+## 1.0.0-beta.2 (2021-11-30)
 
 The package of @azure/arm-portal is using our next generation design principles since version 1.0.0-beta.2, which contains breaking changes.
 

package/LICENSE

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

package/README.md

@@ -1,6 +1,6 @@
-# Azure Service client library for JavaScript
+# Azure Portal client library for JavaScript
 
-This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Portal client.
 
 Allows creation and deletion of Azure Shared Dashboards.
 
@@ -13,7 +13,7 @@ Allows creation and deletion of Azure Shared Dashboards.
 
 ### Currently supported environments
 
-- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
 - Latest versions of Safari, Chrome, Edge and Firefox.
 
 See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
@@ -24,7 +24,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
 
 ### Install the `@azure/arm-portal` package
 
-Install the Azure Service client library for JavaScript with `npm`:
+Install the Azure Portal client library for JavaScript with `npm`:
 
 ```bash
 npm install @azure/arm-portal
@@ -32,8 +32,8 @@ npm install @azure/arm-portal
 
 ### Create and authenticate a `Portal`
 
-To create a client object to access the Azure Service API, you will need the `endpoint` of your Azure Service resource and a `credential`. The Azure Service client can use Azure Active Directory credentials to authenticate.
-You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal].
+To create a client object to access the Azure Portal API, you will need the `endpoint` of your Azure Portal resource and a `credential`. The Azure Portal client can use Azure Active Directory credentials to authenticate.
+You can find the endpoint for your Azure Portal resource in the [Azure Portal][azure_portal].
 
 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).
 
@@ -43,7 +43,7 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
 npm install @azure/identity
 ```
 
-You will also need to **register a new AAD application and grant access to Azure Service** 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 Portal** 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).
@@ -72,7 +72,7 @@ To use this client library in the browser, first you need to use a bundler. For
 
 ### Portal
 
-`Portal` is the primary interface for developers using the Azure Service client library. Explore the methods on this client object to understand the different features of the Azure Service service that you can access.
+`Portal` is the primary interface for developers using the Azure Portal client library. Explore the methods on this client object to understand the different features of the Azure Portal service that you can access.
 
 ## Troubleshooting
 

package/dist/index.js

@@ -2,9 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var tslib = require('tslib');
 var coreClient = require('@azure/core-client');
 var coreRestPipeline = require('@azure/core-rest-pipeline');
-var tslib = require('tslib');
 
 function _interopNamespace(e) {
     if (e && e.__esModule) return e;
@@ -27,6 +27,38 @@ function _interopNamespace(e) {
 var coreClient__namespace = /*#__PURE__*/_interopNamespace(coreClient);
 var coreRestPipeline__namespace = /*#__PURE__*/_interopNamespace(coreRestPipeline);
 
+/*
+ * 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.
+ */
+const pageMap = new WeakMap();
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+function getContinuationToken(page) {
+    var _a;
+    if (typeof page !== "object" || page === null) {
+        return undefined;
+    }
+    return (_a = pageMap.get(page)) === null || _a === void 0 ? void 0 : _a.continuationToken;
+}
+function setContinuationToken(page, continuationToken) {
+    var _a;
+    if (typeof page !== "object" || page === null || !continuationToken) {
+        return;
+    }
+    const pageInfo = (_a = pageMap.get(page)) !== null && _a !== void 0 ? _a : {};
+    pageInfo.continuationToken = continuationToken;
+    pageMap.set(page, pageInfo);
+}
+
 /*
  * Copyright (c) Microsoft Corporation.
  * Licensed under the MIT License.
@@ -37,6 +69,7 @@ var coreRestPipeline__namespace = /*#__PURE__*/_interopNamespace(coreRestPipelin
 /** Known values of {@link ConfigurationName} that the service accepts. */
 exports.KnownConfigurationName = void 0;
 (function (KnownConfigurationName) {
+    /** Default */
     KnownConfigurationName["Default"] = "default";
 })(exports.KnownConfigurationName || (exports.KnownConfigurationName = {}));
 
@@ -840,20 +873,31 @@ class OperationsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -920,7 +964,6 @@ const listNextOperationSpec$2 = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
     serializer: serializer$3
@@ -957,20 +1000,31 @@ class DashboardsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listByResourceGroupPagingPage(resourceGroupName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listByResourceGroupPagingPage(resourceGroupName, options, settings);
             }
         };
     }
-    listByResourceGroupPagingPage(resourceGroupName, options) {
+    listByResourceGroupPagingPage(resourceGroupName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listByResourceGroupPagingPage_1() {
-            let result = yield tslib.__await(this._listByResourceGroup(resourceGroupName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listByResourceGroup(resourceGroupName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listByResourceGroupNext(resourceGroupName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1005,20 +1059,31 @@ class DashboardsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listBySubscriptionPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listBySubscriptionPagingPage(options, settings);
             }
         };
     }
-    listBySubscriptionPagingPage(options) {
+    listBySubscriptionPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listBySubscriptionPagingPage_1() {
-            let result = yield tslib.__await(this._listBySubscription(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listBySubscription(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listBySubscriptionNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1252,7 +1317,6 @@ const listByResourceGroupNextOperationSpec = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -1273,7 +1337,6 @@ const listBySubscriptionNextOperationSpec = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [
         $host,
         nextLink,
@@ -1313,20 +1376,31 @@ class TenantConfigurationsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1472,7 +1546,6 @@ const listNextOperationSpec$1 = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
     serializer: serializer$1
@@ -1508,20 +1581,31 @@ class ListTenantConfigurationViolationsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -1588,7 +1672,6 @@ const listNextOperationSpec = {
             bodyMapper: ErrorResponse
         }
     },
-    queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
     serializer
@@ -1610,7 +1693,7 @@ class Portal extends coreClient__namespace.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials, subscriptionId, options) {
-        var _a, _b;
+        var _a, _b, _c;
         if (credentials === undefined) {
             throw new Error("'credentials' cannot be null");
         }
@@ -1625,32 +1708,34 @@ class Portal extends coreClient__namespace.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.3`;
+        const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.5`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
-        if (!options.credentialScopes) {
-            options.credentialScopes = ["https://management.azure.com/.default"];
-        }
         const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
                 userAgentPrefix
-            }, baseUri: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "https://management.azure.com" });
+            }, endpoint: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "https://management.azure.com" });
         super(optionsWithDefaults);
+        let bearerTokenAuthenticationPolicyFound = false;
         if ((options === null || options === void 0 ? void 0 : options.pipeline) && options.pipeline.getOrderedPolicies().length > 0) {
             const pipelinePolicies = options.pipeline.getOrderedPolicies();
-            const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some((pipelinePolicy) => pipelinePolicy.name ===
+            bearerTokenAuthenticationPolicyFound = pipelinePolicies.some((pipelinePolicy) => pipelinePolicy.name ===
                 coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName);
-            if (!bearerTokenAuthenticationPolicyFound) {
-                this.pipeline.removePolicy({
-                    name: coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName
-                });
-                this.pipeline.addPolicy(coreRestPipeline__namespace.bearerTokenAuthenticationPolicy({
-                    scopes: `${optionsWithDefaults.baseUri}/.default`,
-                    challengeCallbacks: {
-                        authorizeRequestOnChallenge: coreClient__namespace.authorizeRequestOnClaimChallenge
-                    }
-                }));
-            }
+        }
+        if (!options ||
+            !options.pipeline ||
+            options.pipeline.getOrderedPolicies().length == 0 ||
+            !bearerTokenAuthenticationPolicyFound) {
+            this.pipeline.removePolicy({
+                name: coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName
+            });
+            this.pipeline.addPolicy(coreRestPipeline__namespace.bearerTokenAuthenticationPolicy({
+                credential: credentials,
+                scopes: (_c = optionsWithDefaults.credentialScopes) !== null && _c !== void 0 ? _c : `${optionsWithDefaults.endpoint}/.default`,
+                challengeCallbacks: {
+                    authorizeRequestOnChallenge: coreClient__namespace.authorizeRequestOnClaimChallenge
+                }
+            }));
         }
         // Parameter assignments
         this.subscriptionId = subscriptionId;
@@ -1661,8 +1746,37 @@ class Portal extends coreClient__namespace.ServiceClient {
         this.dashboards = new DashboardsImpl(this);
         this.tenantConfigurations = new TenantConfigurationsImpl(this);
         this.listTenantConfigurationViolations = new ListTenantConfigurationViolationsImpl(this);
+        this.addCustomApiVersionPolicy(options.apiVersion);
+    }
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    addCustomApiVersionPolicy(apiVersion) {
+        if (!apiVersion) {
+            return;
+        }
+        const apiVersionPolicy = {
+            name: "CustomApiVersionPolicy",
+            sendRequest(request, next) {
+                return tslib.__awaiter(this, void 0, void 0, function* () {
+                    const param = request.url.split("?");
+                    if (param.length > 1) {
+                        const newParams = param[1].split("&").map((item) => {
+                            if (item.indexOf("api-version") > -1) {
+                                return "api-version=" + apiVersion;
+                            }
+                            else {
+                                return item;
+                            }
+                        });
+                        request.url = param[0] + "?" + newParams.join("&");
+                    }
+                    return next(request);
+                });
+            }
+        };
+        this.pipeline.addPolicy(apiVersionPolicy);
     }
 }
 
 exports.Portal = Portal;
+exports.getContinuationToken = getContinuationToken;
 //# sourceMappingURL=index.js.map