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

package/CHANGELOG.md

@@ -1,5 +1,13 @@
-## Release History
+# Release History
+    
+## 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**

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.
 
@@ -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;
@@ -37,6 +37,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 = {}));
 
@@ -1625,7 +1626,7 @@ 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.4`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1661,6 +1662,34 @@ 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);
     }
 }