@azure/arm-portal 1.0.0-beta.1 → 1.0.0-beta.4

package/CHANGELOG.md

@@ -1,3 +1,25 @@
-## 1.0.0-beta.1 (2021-11-30)
+# Release History
+    
+## 1.0.0-beta.4 (2022-07-08)
+    
+**Features**
 
-  - Initial Release
+  - 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)
+
+The package of @azure/arm-portal is using our next generation design principles since version 1.0.0-beta.2, which contains breaking changes.
+
+To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog).
+
+To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).
+
+To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart).

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Microsoft
+Copyright (c) 2022 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.
 
@@ -16,13 +16,15 @@ Allows creation and deletion of Azure Shared Dashboards.
 - [LTS versions of Node.js](https://nodejs.org/about/releases/)
 - 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.
+
 ### Prerequisites
 
 - An [Azure subscription][azure_sub].
 
 ### 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
@@ -30,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).
 
@@ -41,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).
@@ -49,8 +51,17 @@ For more information about how to create an Azure AD Application check out [this
 ```javascript
 const { Portal } = require("@azure/arm-portal");
 const { DefaultAzureCredential } = require("@azure/identity");
+// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
+
 const subscriptionId = "00000000-0000-0000-0000-000000000000";
 const client = new Portal(new DefaultAzureCredential(), subscriptionId);
+
+// For client-side applications running in the browser, use this code instead:
+// const credential = new InteractiveBrowserCredential({
+//   tenantId: "<YOUR_TENANT_ID>",
+//   clientId: "<YOUR_CLIENT_ID>"
+// });
+// const client = new Portal(credential, subscriptionId);
 ```
 
 
@@ -61,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,8 +2,30 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var coreClient = require('@azure/core-client');
 var tslib = require('tslib');
+var coreClient = require('@azure/core-client');
+var coreRestPipeline = require('@azure/core-rest-pipeline');
+
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var coreClient__namespace = /*#__PURE__*/_interopNamespace(coreClient);
+var coreRestPipeline__namespace = /*#__PURE__*/_interopNamespace(coreRestPipeline);
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -12,7 +34,10 @@ var tslib = require('tslib');
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
+/** Known values of {@link ConfigurationName} that the service accepts. */
+exports.KnownConfigurationName = void 0;
 (function (KnownConfigurationName) {
+    /** Default */
     KnownConfigurationName["Default"] = "default";
 })(exports.KnownConfigurationName || (exports.KnownConfigurationName = {}));
 
@@ -856,7 +881,7 @@ class OperationsImpl {
      * @param options The options parameters.
      */
     _list(options) {
-        return this.client.sendOperationRequest({ options }, listOperationSpec);
+        return this.client.sendOperationRequest({ options }, listOperationSpec$2);
     }
     /**
      * ListNext
@@ -864,12 +889,12 @@ class OperationsImpl {
      * @param options The options parameters.
      */
     _listNext(nextLink, options) {
-        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec);
+        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec$2);
     }
 }
 // Operation Specifications
-const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
-const listOperationSpec = {
+const serializer$3 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
+const listOperationSpec$2 = {
     path: "/providers/Microsoft.Portal/operations",
     httpMethod: "GET",
     responses: {
@@ -883,9 +908,9 @@ const listOperationSpec = {
     queryParameters: [apiVersion],
     urlParameters: [$host],
     headerParameters: [accept],
-    serializer
+    serializer: serializer$3
 };
-const listNextOperationSpec = {
+const listNextOperationSpec$2 = {
     path: "{nextLink}",
     httpMethod: "GET",
     responses: {
@@ -899,7 +924,7 @@ const listNextOperationSpec = {
     queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
-    serializer
+    serializer: serializer$3
 };
 
 /*
@@ -1033,7 +1058,7 @@ class DashboardsImpl {
      * @param options The options parameters.
      */
     delete(resourceGroupName, dashboardName, options) {
-        return this.client.sendOperationRequest({ resourceGroupName, dashboardName, options }, deleteOperationSpec);
+        return this.client.sendOperationRequest({ resourceGroupName, dashboardName, options }, deleteOperationSpec$1);
     }
     /**
      * Gets the Dashboard.
@@ -1042,7 +1067,7 @@ class DashboardsImpl {
      * @param options The options parameters.
      */
     get(resourceGroupName, dashboardName, options) {
-        return this.client.sendOperationRequest({ resourceGroupName, dashboardName, options }, getOperationSpec);
+        return this.client.sendOperationRequest({ resourceGroupName, dashboardName, options }, getOperationSpec$1);
     }
     /**
      * Updates an existing Dashboard.
@@ -1088,7 +1113,7 @@ class DashboardsImpl {
     }
 }
 // Operation Specifications
-const serializer$1 = coreClient.createSerializer(Mappers, /* isXml */ false);
+const serializer$2 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
 const createOrUpdateOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}",
     httpMethod: "PUT",
@@ -1113,9 +1138,9 @@ const createOrUpdateOperationSpec = {
     ],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer: serializer$1
+    serializer: serializer$2
 };
-const deleteOperationSpec = {
+const deleteOperationSpec$1 = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}",
     httpMethod: "DELETE",
     responses: {
@@ -1133,9 +1158,9 @@ const deleteOperationSpec = {
         dashboardName
     ],
     headerParameters: [accept],
-    serializer: serializer$1
+    serializer: serializer$2
 };
-const getOperationSpec = {
+const getOperationSpec$1 = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}",
     httpMethod: "GET",
     responses: {
@@ -1155,7 +1180,7 @@ const getOperationSpec = {
         dashboardName
     ],
     headerParameters: [accept],
-    serializer: serializer$1
+    serializer: serializer$2
 };
 const updateOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}",
@@ -1179,7 +1204,7 @@ const updateOperationSpec = {
     ],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer: serializer$1
+    serializer: serializer$2
 };
 const listByResourceGroupOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards",
@@ -1199,7 +1224,7 @@ const listByResourceGroupOperationSpec = {
         resourceGroupName
     ],
     headerParameters: [accept],
-    serializer: serializer$1
+    serializer: serializer$2
 };
 const listBySubscriptionOperationSpec = {
     path: "/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards",
@@ -1215,7 +1240,7 @@ const listBySubscriptionOperationSpec = {
     queryParameters: [apiVersion],
     urlParameters: [$host, subscriptionId],
     headerParameters: [accept],
-    serializer: serializer$1
+    serializer: serializer$2
 };
 const listByResourceGroupNextOperationSpec = {
     path: "{nextLink}",
@@ -1236,7 +1261,7 @@ const listByResourceGroupNextOperationSpec = {
         resourceGroupName
     ],
     headerParameters: [accept],
-    serializer: serializer$1
+    serializer: serializer$2
 };
 const listBySubscriptionNextOperationSpec = {
     path: "{nextLink}",
@@ -1256,7 +1281,7 @@ const listBySubscriptionNextOperationSpec = {
         subscriptionId
     ],
     headerParameters: [accept],
-    serializer: serializer$1
+    serializer: serializer$2
 };
 
 /*
@@ -1337,7 +1362,7 @@ class TenantConfigurationsImpl {
      * @param options The options parameters.
      */
     get(configurationName, options) {
-        return this.client.sendOperationRequest({ configurationName, options }, getOperationSpec$1);
+        return this.client.sendOperationRequest({ configurationName, options }, getOperationSpec);
     }
     /**
      * Create the tenant configuration. If configuration already exists - update it. User has to be a
@@ -1355,7 +1380,7 @@ class TenantConfigurationsImpl {
      * @param options The options parameters.
      */
     delete(configurationName, options) {
-        return this.client.sendOperationRequest({ configurationName, options }, deleteOperationSpec$1);
+        return this.client.sendOperationRequest({ configurationName, options }, deleteOperationSpec);
     }
     /**
      * ListNext
@@ -1367,7 +1392,7 @@ class TenantConfigurationsImpl {
     }
 }
 // Operation Specifications
-const serializer$2 = coreClient.createSerializer(Mappers, /* isXml */ false);
+const serializer$1 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
 const listOperationSpec$1 = {
     path: "/providers/Microsoft.Portal/tenantConfigurations",
     httpMethod: "GET",
@@ -1382,9 +1407,9 @@ const listOperationSpec$1 = {
     queryParameters: [apiVersion],
     urlParameters: [$host],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer: serializer$1
 };
-const getOperationSpec$1 = {
+const getOperationSpec = {
     path: "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}",
     httpMethod: "GET",
     responses: {
@@ -1399,7 +1424,7 @@ const getOperationSpec$1 = {
     queryParameters: [apiVersion],
     urlParameters: [$host, configurationName],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer: serializer$1
 };
 const createOperationSpec = {
     path: "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}",
@@ -1420,9 +1445,9 @@ const createOperationSpec = {
     urlParameters: [$host, configurationName],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer: serializer$2
+    serializer: serializer$1
 };
-const deleteOperationSpec$1 = {
+const deleteOperationSpec = {
     path: "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}",
     httpMethod: "DELETE",
     responses: {
@@ -1435,7 +1460,7 @@ const deleteOperationSpec$1 = {
     queryParameters: [apiVersion],
     urlParameters: [$host, configurationName],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer: serializer$1
 };
 const listNextOperationSpec$1 = {
     path: "{nextLink}",
@@ -1451,7 +1476,7 @@ const listNextOperationSpec$1 = {
     queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer: serializer$1
 };
 
 /*
@@ -1524,7 +1549,7 @@ class ListTenantConfigurationViolationsImpl {
      * @param options The options parameters.
      */
     _list(options) {
-        return this.client.sendOperationRequest({ options }, listOperationSpec$2);
+        return this.client.sendOperationRequest({ options }, listOperationSpec);
     }
     /**
      * ListNext
@@ -1532,12 +1557,12 @@ class ListTenantConfigurationViolationsImpl {
      * @param options The options parameters.
      */
     _listNext(nextLink, options) {
-        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec$2);
+        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec);
     }
 }
 // Operation Specifications
-const serializer$3 = coreClient.createSerializer(Mappers, /* isXml */ false);
-const listOperationSpec$2 = {
+const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
+const listOperationSpec = {
     path: "/providers/Microsoft.Portal/listTenantConfigurationViolations",
     httpMethod: "POST",
     responses: {
@@ -1551,9 +1576,9 @@ const listOperationSpec$2 = {
     queryParameters: [apiVersion],
     urlParameters: [$host],
     headerParameters: [accept],
-    serializer: serializer$3
+    serializer
 };
-const listNextOperationSpec$2 = {
+const listNextOperationSpec = {
     path: "{nextLink}",
     httpMethod: "GET",
     responses: {
@@ -1567,7 +1592,7 @@ const listNextOperationSpec$2 = {
     queryParameters: [apiVersion],
     urlParameters: [$host, nextLink],
     headerParameters: [accept],
-    serializer: serializer$3
+    serializer
 };
 
 /*
@@ -1577,7 +1602,7 @@ const listNextOperationSpec$2 = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-class Portal extends coreClient.ServiceClient {
+class Portal extends coreClient__namespace.ServiceClient {
     /**
      * Initializes a new instance of the Portal class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
@@ -1586,6 +1611,7 @@ class Portal extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials, subscriptionId, options) {
+        var _a, _b;
         if (credentials === undefined) {
             throw new Error("'credentials' cannot be null");
         }
@@ -1600,7 +1626,7 @@ class Portal extends coreClient.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.1`;
+        const packageDetails = `azsdk-js-arm-portal/1.0.0-beta.4`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1609,8 +1635,24 @@ class Portal extends coreClient.ServiceClient {
         }
         const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
                 userAgentPrefix
-            }, baseUri: options.endpoint || "https://management.azure.com" });
+            }, baseUri: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "https://management.azure.com" });
         super(optionsWithDefaults);
+        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 ===
+                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
+                    }
+                }));
+            }
+        }
         // Parameter assignments
         this.subscriptionId = subscriptionId;
         // Assigning values to Constant parameters
@@ -1620,6 +1662,34 @@ class Portal extends coreClient.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);
     }
 }