@azure/arm-extendedlocation 1.0.0-beta.1 → 1.0.0-beta.3

package/CHANGELOG.md

@@ -1,3 +1,54 @@
+# Release History
+
+## 1.0.0-beta.3 (2023-01-10)
+
+**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.2 (2022-07-20)
+    
+**Features**
+
+  - Added operation group ResourceSyncRules
+  - Added operation CustomLocations.findTargetResourceGroup
+  - Added Interface CustomLocation
+  - Added Interface CustomLocationFindTargetResourceGroupProperties
+  - Added Interface CustomLocationFindTargetResourceGroupResult
+  - Added Interface CustomLocationsFindTargetResourceGroupOptionalParams
+  - Added Interface EnabledResourceType
+  - Added Interface MatchExpressionsProperties
+  - Added Interface PatchableResourceSyncRule
+  - Added Interface ProxyResource
+  - Added Interface ResourceSyncRule
+  - Added Interface ResourceSyncRuleListResult
+  - Added Interface ResourceSyncRulePropertiesSelector
+  - Added Interface ResourceSyncRulesCreateOrUpdateOptionalParams
+  - Added Interface ResourceSyncRulesDeleteOptionalParams
+  - Added Interface ResourceSyncRulesGetOptionalParams
+  - Added Interface ResourceSyncRulesListByCustomLocationIDNextOptionalParams
+  - Added Interface ResourceSyncRulesListByCustomLocationIDOptionalParams
+  - Added Interface ResourceSyncRulesUpdateOptionalParams
+  - Added Interface TrackedResource
+  - Added Type Alias CustomLocationsFindTargetResourceGroupResponse
+  - Added Type Alias ResourceSyncRulesCreateOrUpdateResponse
+  - Added Type Alias ResourceSyncRulesGetResponse
+  - Added Type Alias ResourceSyncRulesListByCustomLocationIDNextResponse
+  - Added Type Alias ResourceSyncRulesListByCustomLocationIDResponse
+  - Added Type Alias ResourceSyncRulesUpdateResponse
+  - Class CustomLocationsManagementClient has a new parameter $host
+  - Class CustomLocationsManagementClient has a new parameter apiVersion
+  - Class CustomLocationsManagementClient has a new parameter resourceSyncRules
+  - Class CustomLocationsManagementClient has a new parameter subscriptionId
+
+**Breaking Changes**
+
+  - Deleted Class CustomLocationsManagementClientContext
+    
 ## 1.0.0-beta.1 (2021-10-08)
 
   - Initial Release

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 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,28 +1,30 @@
-# Azure customLocationsManagement client library for JavaScript
+# Azure CustomLocationsManagement client library for JavaScript
 
-This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure customLocationsManagement client.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure CustomLocationsManagement client.
 
 The customLocations Rest API spec.
 
 [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/extendedlocation/arm-extendedlocation) |
 [Package (NPM)](https://www.npmjs.com/package/@azure/arm-extendedlocation) |
-[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-extendedlocation) |
+[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-extendedlocation?view=azure-node-preview) |
 [Samples](https://github.com/Azure-Samples/azure-samples-js-management)
 
 ## Getting started
 
 ### 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.
+
 ### Prerequisites
 
 - An [Azure subscription][azure_sub].
 
 ### Install the `@azure/arm-extendedlocation` package
 
-Install the Azure customLocationsManagement client library for JavaScript with `npm`:
+Install the Azure CustomLocationsManagement client library for JavaScript with `npm`:
 
 ```bash
 npm install @azure/arm-extendedlocation
@@ -30,8 +32,8 @@ npm install @azure/arm-extendedlocation
 
 ### Create and authenticate a `CustomLocationsManagementClient`
 
-To create a client object to access the Azure customLocationsManagement API, you will need the `endpoint` of your Azure customLocationsManagement resource and a `credential`. The Azure customLocationsManagement client can use Azure Active Directory credentials to authenticate.
-You can find the endpoint for your Azure customLocationsManagement resource in the [Azure Portal][azure_portal].
+To create a client object to access the Azure CustomLocationsManagement API, you will need the `endpoint` of your Azure CustomLocationsManagement resource and a `credential`. The Azure CustomLocationsManagement client can use Azure Active Directory credentials to authenticate.
+You can find the endpoint for your Azure CustomLocationsManagement 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 customLocationsManagement** 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 CustomLocationsManagement** 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,15 +51,28 @@ For more information about how to create an Azure AD Application check out [this
 ```javascript
 const { CustomLocationsManagementClient } = require("@azure/arm-extendedlocation");
 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 CustomLocationsManagementClient(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 CustomLocationsManagementClient(credential, 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
 
 ### CustomLocationsManagementClient
 
-`CustomLocationsManagementClient` is the primary interface for developers using the Azure customLocationsManagement client library. Explore the methods on this client object to understand the different features of the Azure customLocationsManagement service that you can access.
+`CustomLocationsManagementClient` is the primary interface for developers using the Azure CustomLocationsManagement client library. Explore the methods on this client object to understand the different features of the Azure CustomLocationsManagement service that you can access.
 
 ## Troubleshooting