@azure/arm-compute 16.5.0 → 17.0.0-beta.2

package/CHANGELOG.md

@@ -0,0 +1,85 @@
+## 17.0.0-beta.2 (2021-10-18)
+    
+**Features**
+
+  - Added operation group CommunityGalleries
+  - Added operation group CommunityGalleryImages
+  - Added operation group CommunityGalleryImageVersions
+  - Added Interface CommunityGalleriesGetOptionalParams
+  - Added Interface CommunityGalleryImagesGetOptionalParams
+  - Added Interface CommunityGalleryImageVersionsGetOptionalParams
+  - Added Interface DiskRestorePointGetOptionalParams
+  - Added Interface DiskRestorePointGrantAccessOptionalParams
+  - Added Interface DiskRestorePointListByRestorePointNextOptionalParams
+  - Added Interface DiskRestorePointListByRestorePointOptionalParams
+  - Added Interface DiskRestorePointRevokeAccessOptionalParams
+  - Added Interface PirCommunityGalleryResource
+  - Added Interface SupportedCapabilities
+  - Added Interface UsageListNextOptionalParams
+  - Added Interface UsageListOptionalParams
+  - Added Type Alias CommunityGalleriesGetResponse
+  - Added Type Alias CommunityGallery
+  - Added Type Alias CommunityGalleryImage
+  - Added Type Alias CommunityGalleryImagesGetResponse
+  - Added Type Alias CommunityGalleryImageVersion
+  - Added Type Alias CommunityGalleryImageVersionsGetResponse
+  - Added Type Alias DiskRestorePointGetResponse
+  - Added Type Alias DiskRestorePointGrantAccessResponse
+  - Added Type Alias DiskRestorePointListByRestorePointNextResponse
+  - Added Type Alias DiskRestorePointListByRestorePointResponse
+  - Added Type Alias Image
+  - Added Type Alias PublicNetworkAccess
+  - Added Type Alias UsageListNextResponse
+  - Added Type Alias UsageListResponse
+  - Interface DiskUpdate has a new optional parameter publicNetworkAccess
+  - Interface DiskUpdate has a new optional parameter supportedCapabilities
+  - Interface SnapshotUpdate has a new optional parameter publicNetworkAccess
+  - Class ComputeManagementClient has a new parameter communityGalleries
+  - Class ComputeManagementClient has a new parameter communityGalleryImages
+  - Class ComputeManagementClient has a new parameter communityGalleryImageVersions
+  - Type Alias Disk has a new parameter supportedCapabilities
+  - Type Alias Disk has a new parameter completionPercent
+  - Type Alias Disk has a new parameter publicNetworkAccess
+  - Type Alias DiskAccess has a new parameter extendedLocation
+  - Type Alias DiskEncryptionSet has a new parameter autoKeyRotationError
+  - Type Alias DiskRestorePoint has a new parameter supportedCapabilities
+  - Type Alias DiskRestorePoint has a new parameter networkAccessPolicy
+  - Type Alias DiskRestorePoint has a new parameter publicNetworkAccess
+  - Type Alias DiskRestorePoint has a new parameter diskAccessId
+  - Type Alias DiskRestorePoint has a new parameter completionPercent
+  - Type Alias Snapshot has a new parameter supportedCapabilities
+  - Type Alias Snapshot has a new parameter publicNetworkAccess
+  - Type Alias Snapshot has a new parameter completionPercent
+  - Added Enum KnownPublicNetworkAccess
+  - Enum KnownDiskCreateOption has a new value CopyStart
+  - Enum KnownDiskState has a new value ActiveSASFrozen
+  - Enum KnownDiskState has a new value Frozen
+
+**Breaking Changes**
+
+  - Operation DiskRestorePointOperations.beginGrantAccess has a new signature
+  - Operation DiskRestorePointOperations.beginGrantAccessAndWait has a new signature
+  - Operation DiskRestorePointOperations.beginRevokeAccess has a new signature
+  - Operation DiskRestorePointOperations.beginRevokeAccessAndWait has a new signature
+  - Operation DiskRestorePointOperations.get has a new signature
+  - Operation DiskRestorePointOperations.listByRestorePoint has a new signature
+  - Operation Images.beginCreateOrUpdate has a new signature
+  - Operation Images.beginCreateOrUpdateAndWait has a new signature
+  - Operation UsageOperations.list has a new signature
+    
+# Release History
+
+## 17.0.0-beta.1 (2021-10-09)
+
+This is the first preview for the new version of the `@azure/arm-compute` package that follows the new [guidelines for TypeScript SDKs](https://azure.github.io/azure-sdk/typescript_introduction.html) for Azure services.
+
+While this package remains auto generated, the SDK generator itself has undergone changes to comply with the above guidelines in order to generate packages that are idiomatic to the JavaScript/TypeScript ecosystem and consistent with other packages for Azure services. For more on this, please see [State of the Azure SDK 2021](https://devblogs.microsoft.com/azure-sdk/state-of-the-azure-sdk-2021/).
+
+Please note that this version has breaking changes, all of which were made after careful consideration during the authoring of the guidelines and user studies.
+
+**Noteworthy changes and features**
+- Authentication: The packages `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` are no longer supported. Use package [@azure/identity](https://www.npmjs.com/package/@azure/identity) instead. Select a credential from Azure Identity examples based on the authentication method of your choice.
+- Callbacks: Method overloads that used callbacks have been removed and the use of promises is encouraged instead.
+- List operations now return an iterable result that follows the `PagedAsyncIterableIterator` interface as opposed to the previous model where you had to make a new request using the link to the next page.
+- Long running operations i.e. the methods whose names started with `begin` now return a poller object that gives you a better control over the operation. To get the final result like before use the corresponding method that will have the suffix `AndWait`.
+- The SDK only supports ECMAScript 2015 (ES6) and beyond, all projects that referenced this SDK should be upgraded to use ES6.

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,15 @@
-## Azure ComputeManagementClient SDK for JavaScript
+# Azure ComputeManagement client library for JavaScript
 
-This package contains an isomorphic SDK (runs both in node.js and in browsers) for ComputeManagementClient.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure ComputeManagement client.
+
+Compute Client
+
+[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/compute/arm-compute) |
+[Package (NPM)](https://www.npmjs.com/package/@azure/arm-compute) |
+[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-compute) |
+[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
+
+## Getting started
 
 ### Currently supported environments
 
@@ -9,98 +18,77 @@ This package contains an isomorphic SDK (runs both in node.js and in browsers) f
 
 ### Prerequisites
 
-You must have an [Azure subscription](https://azure.microsoft.com/free/).
+- An [Azure subscription][azure_sub].
 
-### How to install
+### Install the `@azure/arm-compute` package
 
-To use this SDK in your project, you will need to install two packages.
-- `@azure/arm-compute` that contains the client.
-- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
+Install the Azure ComputeManagement client library for JavaScript with `npm`:
 
-Install both packages using the below command:
 ```bash
-npm install --save @azure/arm-compute @azure/identity
+npm install @azure/arm-compute
 ```
-> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
-If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.
 
-### How to use
+### Create and authenticate a `ComputeManagementClient`
+
+To create a client object to access the Azure ComputeManagement API, you will need the `endpoint` of your Azure ComputeManagement resource and a `credential`. The Azure ComputeManagement client can use Azure Active Directory credentials to authenticate.
+You can find the endpoint for your Azure ComputeManagement 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).
+
+To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
 
-- If you are writing a client side browser application,
-  - Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
-  - Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
-- If you are writing a server side application,
-  - [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
-  - Complete the set up steps required by the credential if any.
-  - Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.
+```bash
+npm install @azure/identity
+```
 
-In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
-Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
-#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript.
+You will also need to **register a new AAD application and grant access to Azure ComputeManagement** 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`.
 
-##### Sample code
+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).
 
 ```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
 const { ComputeManagementClient } = require("@azure/arm-compute");
-const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
-
-// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
-// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
-const creds = new DefaultAzureCredential();
-const client = new ComputeManagementClient(creds, subscriptionId);
-client.operations.list().then((result) => {
-  console.log("The result is:");
-  console.log(result);
-}).catch((err) => {
-  console.log("An error occurred:");
-  console.error(err);
-});
+const { DefaultAzureCredential } = require("@azure/identity");
+const subscriptionId = "00000000-0000-0000-0000-000000000000";
+const client = new ComputeManagementClient(new DefaultAzureCredential(), subscriptionId);
 ```
 
-#### browser - Authentication, client creation, and list operations as an example written in JavaScript.
-
-In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
-  - See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
-  - Note down the client Id from the previous step and use it in the browser sample below.
-
-##### Sample code
-
-- index.html
-
-```html
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <title>@azure/arm-compute sample</title>
-    <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
-    <script src="node_modules/@azure/identity/dist/index.js"></script>
-    <script src="node_modules/@azure/arm-compute/dist/arm-compute.js"></script>
-    <script type="text/javascript">
-      const subscriptionId = "<Subscription_Id>";
-      // Create credentials using the `@azure/identity` package.
-      // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
-      const credential = new InteractiveBrowserCredential(
-      {
-        clientId: "<client id for your Azure AD app>",
-        tenant: "<optional tenant for your organization>"
-      });
-      const client = new Azure.ArmCompute.ComputeManagementClient(creds, subscriptionId);
-      client.operations.list().then((result) => {
-        console.log("The result is:");
-        console.log(result);
-      }).catch((err) => {
-        console.log("An error occurred:");
-        console.error(err);
-      });
-    </script>
-  </head>
-  <body></body>
-</html>
+## Key concepts
+
+### ComputeManagementClient
+
+`ComputeManagementClient` is the primary interface for developers using the Azure ComputeManagement client library. Explore the methods on this client object to understand the different features of the Azure ComputeManagement service that you can access.
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```javascript
+const { setLogLevel } = require("@azure/logger");
+setLogLevel("info");
 ```
 
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
+
+## Next steps
+
+Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.
+
+## Contributing
+
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
+
 ## Related projects
 
-- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
+- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
+
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcompute%2Farm-compute%2FREADME.png)
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/compute/arm-compute/README.png)
+[azure_cli]: https://docs.microsoft.com/cli/azure
+[azure_sub]: https://azure.microsoft.com/free/
+[azure_sub]: https://azure.microsoft.com/free/
+[azure_portal]: https://portal.azure.com
+[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
+[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential