@azure/arm-confluent 1.0.0 → 2.2.0

package/README.md

@@ -1,89 +1,97 @@
 ## Azure ConfluentManagementClient SDK for JavaScript
 
-This package contains an isomorphic SDK for ConfluentManagementClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for ConfluentManagementClient.
 
 ### Currently supported environments
 
-- Node.js version 6.x.x or higher
-- Browser JavaScript
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- Latest versions of Safari, Chrome, Edge and Firefox.
 
-### How to Install
+### Prerequisites
 
+You must have an [Azure subscription](https://azure.microsoft.com/free/).
+
+### How to install
+
+To use this SDK in your project, you will need to install two packages.
+- `@azure/arm-confluent` that contains the client.
+- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
+
+Install both packages using the below command:
 ```bash
-npm install @azure/arm-confluent
+npm install --save @azure/arm-confluent @azure/identity
 ```
+> **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
 
-#### nodejs - client creation and list marketplaceAgreements as an example written in TypeScript.
+- 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.
 
-##### Install @azure/ms-rest-nodeauth
-
-- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
-```bash
-npm install @azure/ms-rest-nodeauth@"^3.0.0"
-```
+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 marketplaceAgreements as an example written in JavaScript.
 
 ##### Sample code
 
-While the below sample uses the interactive login, other authentication options can be found in the [README.md file of @azure/ms-rest-nodeauth](https://www.npmjs.com/package/@azure/ms-rest-nodeauth) package
-```typescript
-const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
 const { ConfluentManagementClient } = require("@azure/arm-confluent");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new ConfluentManagementClient(creds, subscriptionId);
-  client.marketplaceAgreements.list().then((result) => {
-    console.log("The result is:");
-    console.log(result);
-  });
+// 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 ConfluentManagementClient(creds, subscriptionId);
+client.marketplaceAgreements.list().then((result) => {
+  console.log("The result is:");
+  console.log(result);
 }).catch((err) => {
+  console.log("An error occurred:");
   console.error(err);
 });
 ```
 
-#### browser - Authentication, client creation and list marketplaceAgreements as an example written in JavaScript.
+#### browser - Authentication, client creation, and list marketplaceAgreements as an example written in JavaScript.
 
-##### Install @azure/ms-rest-browserauth
-
-```bash
-npm install @azure/ms-rest-browserauth
-```
+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
 
-See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
-
 - index.html
+
 ```html
 <!DOCTYPE html>
 <html lang="en">
   <head>
     <title>@azure/arm-confluent sample</title>
-    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
     <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
-    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
+    <script src="node_modules/@azure/identity/dist/index.js"></script>
     <script src="node_modules/@azure/arm-confluent/dist/arm-confluent.js"></script>
     <script type="text/javascript">
       const subscriptionId = "<Subscription_Id>";
-      const authManager = new msAuth.AuthManager({
+      // 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>"
       });
-      authManager.finalizeLogin().then((res) => {
-        if (!res.isLoggedIn) {
-          // may cause redirects
-          authManager.login();
-        }
-        const client = new Azure.ArmConfluent.ConfluentManagementClient(res.creds, subscriptionId);
-        client.marketplaceAgreements.list().then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.ArmConfluent.ConfluentManagementClient(creds, subscriptionId);
+      client.marketplaceAgreements.list().then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>

package/dist/arm-confluent.js

@@ -72,6 +72,51 @@
      */
     var CloudError = msRestAzure.CloudErrorMapper;
     var BaseResource = msRestAzure.BaseResourceMapper;
+    var SystemData = {
+        serializedName: "systemData",
+        type: {
+            name: "Composite",
+            className: "SystemData",
+            modelProperties: {
+                createdBy: {
+                    serializedName: "createdBy",
+                    type: {
+                        name: "String"
+                    }
+                },
+                createdByType: {
+                    serializedName: "createdByType",
+                    type: {
+                        name: "String"
+                    }
+                },
+                createdAt: {
+                    serializedName: "createdAt",
+                    type: {
+                        name: "DateTime"
+                    }
+                },
+                lastModifiedBy: {
+                    serializedName: "lastModifiedBy",
+                    type: {
+                        name: "String"
+                    }
+                },
+                lastModifiedByType: {
+                    serializedName: "lastModifiedByType",
+                    type: {
+                        name: "String"
+                    }
+                },
+                lastModifiedAt: {
+                    serializedName: "lastModifiedAt",
+                    type: {
+                        name: "DateTime"
+                    }
+                }
+            }
+        }
+    };
     var ConfluentAgreementResource = {
         serializedName: "ConfluentAgreementResource",
         type: {
@@ -99,6 +144,14 @@
                         name: "String"
                     }
                 },
+                systemData: {
+                    readOnly: true,
+                    serializedName: "systemData",
+                    type: {
+                        name: "Composite",
+                        className: "SystemData"
+                    }
+                },
                 publisher: {
                     serializedName: "properties.publisher",
                     type: {
@@ -278,6 +331,7 @@
             className: "OfferDetail",
             modelProperties: {
                 publisherId: {
+                    required: true,
                     serializedName: "publisherId",
                     constraints: {
                         MaxLength: 50
@@ -287,6 +341,7 @@
                     }
                 },
                 id: {
+                    required: true,
                     serializedName: "id",
                     constraints: {
                         MaxLength: 50
@@ -296,6 +351,7 @@
                     }
                 },
                 planId: {
+                    required: true,
                     serializedName: "planId",
                     constraints: {
                         MaxLength: 50
@@ -305,6 +361,7 @@
                     }
                 },
                 planName: {
+                    required: true,
                     serializedName: "planName",
                     constraints: {
                         MaxLength: 50
@@ -314,6 +371,7 @@
                     }
                 },
                 termUnit: {
+                    required: true,
                     serializedName: "termUnit",
                     constraints: {
                         MaxLength: 25
@@ -356,9 +414,10 @@
                     }
                 },
                 emailAddress: {
+                    required: true,
                     serializedName: "emailAddress",
                     constraints: {
-                        Pattern: /\S+@\S+\.\S+/
+                        Pattern: /^\S+@\S+\.\S+$/
                     },
                     type: {
                         name: "String"
@@ -367,72 +426,6 @@
             }
         }
     };
-    var OrganizationResourcePropertiesOfferDetail = {
-        serializedName: "OrganizationResourceProperties_offerDetail",
-        type: {
-            name: "Composite",
-            className: "OrganizationResourcePropertiesOfferDetail",
-            modelProperties: __assign({}, OfferDetail.type.modelProperties)
-        }
-    };
-    var OrganizationResourcePropertiesUserDetail = {
-        serializedName: "OrganizationResourceProperties_userDetail",
-        type: {
-            name: "Composite",
-            className: "OrganizationResourcePropertiesUserDetail",
-            modelProperties: __assign({}, UserDetail.type.modelProperties)
-        }
-    };
-    var OrganizationResourceProperties = {
-        serializedName: "OrganizationResourceProperties",
-        type: {
-            name: "Composite",
-            className: "OrganizationResourceProperties",
-            modelProperties: {
-                createdTime: {
-                    readOnly: true,
-                    serializedName: "createdTime",
-                    type: {
-                        name: "DateTime"
-                    }
-                },
-                provisioningState: {
-                    serializedName: "provisioningState",
-                    type: {
-                        name: "String"
-                    }
-                },
-                organizationId: {
-                    readOnly: true,
-                    serializedName: "organizationId",
-                    type: {
-                        name: "String"
-                    }
-                },
-                ssoUrl: {
-                    readOnly: true,
-                    serializedName: "ssoUrl",
-                    type: {
-                        name: "String"
-                    }
-                },
-                offerDetail: {
-                    serializedName: "offerDetail",
-                    type: {
-                        name: "Composite",
-                        className: "OrganizationResourcePropertiesOfferDetail"
-                    }
-                },
-                userDetail: {
-                    serializedName: "userDetail",
-                    type: {
-                        name: "Composite",
-                        className: "OrganizationResourcePropertiesUserDetail"
-                    }
-                }
-            }
-        }
-    };
     var OrganizationResource = {
         serializedName: "OrganizationResource",
         type: {
@@ -460,6 +453,14 @@
                         name: "String"
                     }
                 },
+                systemData: {
+                    readOnly: true,
+                    serializedName: "systemData",
+                    type: {
+                        name: "Composite",
+                        className: "SystemData"
+                    }
+                },
                 createdTime: {
                     readOnly: true,
                     serializedName: "properties.createdTime",
@@ -468,6 +469,7 @@
                     }
                 },
                 provisioningState: {
+                    readOnly: true,
                     serializedName: "properties.provisioningState",
                     type: {
                         name: "String"
@@ -488,17 +490,19 @@
                     }
                 },
                 offerDetail: {
+                    required: true,
                     serializedName: "properties.offerDetail",
                     type: {
                         name: "Composite",
-                        className: "OrganizationResourcePropertiesOfferDetail"
+                        className: "OfferDetail"
                     }
                 },
                 userDetail: {
+                    required: true,
                     serializedName: "properties.userDetail",
                     type: {
                         name: "Composite",
-                        className: "OrganizationResourcePropertiesUserDetail"
+                        className: "UserDetail"
                     }
                 },
                 tags: {
@@ -627,6 +631,7 @@
         __proto__: null,
         CloudError: CloudError,
         BaseResource: BaseResource,
+        SystemData: SystemData,
         ConfluentAgreementResource: ConfluentAgreementResource,
         OperationDisplay: OperationDisplay,
         OperationResult: OperationResult,
@@ -634,9 +639,6 @@
         ResourceProviderDefaultErrorResponse: ResourceProviderDefaultErrorResponse,
         OfferDetail: OfferDetail,
         UserDetail: UserDetail,
-        OrganizationResourcePropertiesOfferDetail: OrganizationResourcePropertiesOfferDetail,
-        OrganizationResourcePropertiesUserDetail: OrganizationResourcePropertiesUserDetail,
-        OrganizationResourceProperties: OrganizationResourceProperties,
         OrganizationResource: OrganizationResource,
         OrganizationResourceUpdate: OrganizationResourceUpdate,
         ConfluentAgreementResourceListResponse: ConfluentAgreementResourceListResponse,
@@ -660,9 +662,8 @@
         ErrorResponseBody: ErrorResponseBody,
         OfferDetail: OfferDetail,
         OrganizationResource: OrganizationResource,
-        OrganizationResourcePropertiesOfferDetail: OrganizationResourcePropertiesOfferDetail,
-        OrganizationResourcePropertiesUserDetail: OrganizationResourcePropertiesUserDetail,
         ResourceProviderDefaultErrorResponse: ResourceProviderDefaultErrorResponse,
+        SystemData: SystemData,
         UserDetail: UserDetail
     });
 
@@ -690,7 +691,7 @@
             required: true,
             isConstant: true,
             serializedName: "api-version",
-            defaultValue: '2020-03-01',
+            defaultValue: '2021-09-01-preview',
             type: {
                 name: "String"
             }
@@ -781,6 +782,9 @@
         urlParameters: [
             subscriptionId
         ],
+        queryParameters: [
+            apiVersion
+        ],
         headerParameters: [
             acceptLanguage
         ],
@@ -800,6 +804,9 @@
         urlParameters: [
             subscriptionId
         ],
+        queryParameters: [
+            apiVersion
+        ],
         headerParameters: [
             acceptLanguage
         ],
@@ -827,6 +834,9 @@
         urlParameters: [
             nextPageLink
         ],
+        queryParameters: [
+            apiVersion
+        ],
         headerParameters: [
             acceptLanguage
         ],
@@ -949,10 +959,9 @@
         OfferDetail: OfferDetail,
         OrganizationResource: OrganizationResource,
         OrganizationResourceListResult: OrganizationResourceListResult,
-        OrganizationResourcePropertiesOfferDetail: OrganizationResourcePropertiesOfferDetail,
-        OrganizationResourcePropertiesUserDetail: OrganizationResourcePropertiesUserDetail,
         OrganizationResourceUpdate: OrganizationResourceUpdate,
         ResourceProviderDefaultErrorResponse: ResourceProviderDefaultErrorResponse,
+        SystemData: SystemData,
         UserDetail: UserDetail
     });
 
@@ -1269,6 +1278,84 @@
         serializer: serializer$2
     };
 
+    /*
+     * Copyright (c) Microsoft Corporation.
+     * Licensed under the MIT License.
+     *
+     * Code generated by Microsoft (R) AutoRest Code Generator.
+     * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+     */
+
+    var Mappers$3 = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        BaseResource: BaseResource,
+        ConfluentAgreementResource: ConfluentAgreementResource,
+        ErrorResponseBody: ErrorResponseBody,
+        OfferDetail: OfferDetail,
+        OrganizationResource: OrganizationResource,
+        ResourceProviderDefaultErrorResponse: ResourceProviderDefaultErrorResponse,
+        SystemData: SystemData,
+        UserDetail: UserDetail
+    });
+
+    /*
+     * Copyright (c) Microsoft Corporation.
+     * Licensed under the MIT License.
+     *
+     * Code generated by Microsoft (R) AutoRest Code Generator.
+     * Changes may cause incorrect behavior and will be lost if the code is
+     * regenerated.
+     */
+    /** Class representing a Validations. */
+    var Validations = /** @class */ (function () {
+        /**
+         * Create a Validations.
+         * @param {ConfluentManagementClientContext} client Reference to the service client.
+         */
+        function Validations(client) {
+            this.client = client;
+        }
+        Validations.prototype.validateOrganization = function (resourceGroupName, organizationName, body, options, callback) {
+            return this.client.sendOperationRequest({
+                resourceGroupName: resourceGroupName,
+                organizationName: organizationName,
+                body: body,
+                options: options
+            }, validateOrganizationOperationSpec, callback);
+        };
+        return Validations;
+    }());
+    // Operation Specifications
+    var serializer$3 = new msRest.Serializer(Mappers$3);
+    var validateOrganizationOperationSpec = {
+        httpMethod: "POST",
+        path: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidate",
+        urlParameters: [
+            subscriptionId,
+            resourceGroupName,
+            organizationName
+        ],
+        queryParameters: [
+            apiVersion
+        ],
+        headerParameters: [
+            acceptLanguage
+        ],
+        requestBody: {
+            parameterPath: "body",
+            mapper: __assign(__assign({}, OrganizationResource), { required: true })
+        },
+        responses: {
+            200: {
+                bodyMapper: OrganizationResource
+            },
+            default: {
+                bodyMapper: ResourceProviderDefaultErrorResponse
+            }
+        },
+        serializer: serializer$3
+    };
+
     /*
      * Copyright (c) Microsoft Corporation.
      * Licensed under the MIT License.
@@ -1278,12 +1365,17 @@
      * regenerated.
      */
     var packageName = "@azure/arm-confluent";
-    var packageVersion = "1.0.0";
+    var packageVersion = "2.2.0";
     var ConfluentManagementClientContext = /** @class */ (function (_super) {
         __extends(ConfluentManagementClientContext, _super);
         /**
          * Initializes a new instance of the ConfluentManagementClient class.
-         * @param credentials Credentials needed for the client to connect to Azure.
+         * @param credentials Credentials needed for the client to connect to Azure. Credentials
+         * implementing the TokenCredential interface from the @azure/identity package are recommended. For
+         * more information about these credentials, see
+         * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
+         * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
+         * @azure/ms-rest-browserauth are also supported.
          * @param subscriptionId Microsoft Azure subscription id
          * @param [options] The parameter options
          */
@@ -1303,7 +1395,7 @@
                 options.userAgent = packageName + "/" + packageVersion + " " + defaultUserAgent;
             }
             _this = _super.call(this, credentials, options) || this;
-            _this.apiVersion = '2020-03-01';
+            _this.apiVersion = '2021-09-01-preview';
             _this.acceptLanguage = 'en-US';
             _this.longRunningOperationRetryTimeout = 30;
             _this.baseUri = options.baseUri || _this.baseUri || "https://management.azure.com";
@@ -1333,7 +1425,12 @@
         __extends(ConfluentManagementClient, _super);
         /**
          * Initializes a new instance of the ConfluentManagementClient class.
-         * @param credentials Credentials needed for the client to connect to Azure.
+         * @param credentials Credentials needed for the client to connect to Azure. Credentials
+         * implementing the TokenCredential interface from the @azure/identity package are recommended. For
+         * more information about these credentials, see
+         * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
+         * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
+         * @azure/ms-rest-browserauth are also supported.
          * @param subscriptionId Microsoft Azure subscription id
          * @param [options] The parameter options
          */
@@ -1342,6 +1439,7 @@
             _this.marketplaceAgreements = new MarketplaceAgreements(_this);
             _this.organizationOperations = new OrganizationOperations(_this);
             _this.organization = new Organization(_this);
+            _this.validations = new Validations(_this);
             return _this;
         }
         return ConfluentManagementClient;
@@ -1354,6 +1452,7 @@
     exports.MarketplaceAgreements = MarketplaceAgreements;
     exports.Organization = Organization;
     exports.OrganizationOperations = OrganizationOperations;
+    exports.Validations = Validations;
 
     Object.defineProperty(exports, '__esModule', { value: true });