@azure/arm-relay 3.0.2-alpha.20220506.3 → 3.1.0

package/CHANGELOG.md

@@ -1,15 +1,17 @@
 # Release History
+    
+## 3.1.0 (2022-07-08)
+    
+**Features**
 
-## 3.0.2 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
+  - Added Interface AuthorizationRule
+  - Added Interface HybridConnection
+  - Added Interface RelayNamespace
+  - Added Interface RelayUpdateParameters
+  - Added Interface ResourceNamespacePatch
+  - Added Interface TrackedResource
+  - Added Interface WcfRelay
+    
 ## 3.0.1 (2022-04-29)
 
 **Features**

package/README.md

@@ -1,6 +1,6 @@
-# Azure Service client library for JavaScript
+# Azure RelayApi 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 RelayApi client.
 
 Use these API to manage Azure Relay resources through Azure Resource Manager.
 
@@ -24,7 +24,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
 
 ### Install the `@azure/arm-relay` package
 
-Install the Azure Service client library for JavaScript with `npm`:
+Install the Azure RelayApi client library for JavaScript with `npm`:
 
 ```bash
 npm install @azure/arm-relay
@@ -32,8 +32,8 @@ npm install @azure/arm-relay
 
 ### Create and authenticate a `RelayAPI`
 
-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 RelayApi API, you will need the `endpoint` of your Azure RelayApi resource and a `credential`. The Azure RelayApi client can use Azure Active Directory credentials to authenticate.
+You can find the endpoint for your Azure RelayApi 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 RelayApi** 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
 
 ### RelayAPI
 
-`RelayAPI` 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.
+`RelayAPI` is the primary interface for developers using the Azure RelayApi client library. Explore the methods on this client object to understand the different features of the Azure RelayApi 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');
 var coreLro = require('@azure/core-lro');
 
 function _interopNamespace(e) {
@@ -2907,7 +2907,7 @@ class RelayAPI extends coreClient__namespace.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-relay/3.0.2`;
+        const packageDetails = `azsdk-js-arm-relay/3.1.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -2943,6 +2943,34 @@ class RelayAPI extends coreClient__namespace.ServiceClient {
         this.namespaces = new NamespacesImpl(this);
         this.hybridConnections = new HybridConnectionsImpl(this);
         this.wCFRelays = new WCFRelaysImpl(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);
     }
 }