CodeGen from PR 14839 in Azure/azure-rest-api-specs

Merge e645d31962d81de29ef4eec5ec7008488e33aa8d into 25af5c1c0fae2bc594c1932445d06209745f5917

sdk/synapse/arm-synapse/README.md

@@ -1,95 +1,103 @@
 ## Azure SynapseManagementClient SDK for JavaScript
 
-This package contains an isomorphic SDK for SynapseManagementClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for SynapseManagementClient.
 
 ### 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-synapse` 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-synapse
+npm install --save @azure/arm-synapse @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 get bigDataPools 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 get bigDataPools 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 { SynapseManagementClient } = require("@azure/arm-synapse");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new SynapseManagementClient(creds, subscriptionId);
-  const resourceGroupName = "testresourceGroupName";
-  const workspaceName = "testworkspaceName";
-  const bigDataPoolName = "testbigDataPoolName";
-  client.bigDataPools.get(resourceGroupName, workspaceName, bigDataPoolName).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 SynapseManagementClient(creds, subscriptionId);
+const resourceGroupName = "testresourceGroupName";
+const workspaceName = "testworkspaceName";
+const bigDataPoolName = "testbigDataPoolName";
+client.bigDataPools.get(resourceGroupName, workspaceName, bigDataPoolName).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 get bigDataPools as an example written in JavaScript.
+#### browser - Authentication, client creation, and get bigDataPools 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-synapse 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-synapse/dist/arm-synapse.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.ArmSynapse.SynapseManagementClient(res.creds, subscriptionId);
-        const resourceGroupName = "testresourceGroupName";
-        const workspaceName = "testworkspaceName";
-        const bigDataPoolName = "testbigDataPoolName";
-        client.bigDataPools.get(resourceGroupName, workspaceName, bigDataPoolName).then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.ArmSynapse.SynapseManagementClient(creds, subscriptionId);
+      const resourceGroupName = "testresourceGroupName";
+      const workspaceName = "testworkspaceName";
+      const bigDataPoolName = "testbigDataPoolName";
+      client.bigDataPools.get(resourceGroupName, workspaceName, bigDataPoolName).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>

sdk/synapse/arm-synapse/package.json

@@ -4,8 +4,9 @@
   "description": "SynapseManagementClient Library with typescript type definitions for node.js and browser.",
   "version": "5.1.0",
   "dependencies": {
-    "@azure/ms-rest-azure-js": "^2.0.1",
-    "@azure/ms-rest-js": "^2.0.4",
+    "@azure/ms-rest-azure-js": "^2.1.0",
+    "@azure/ms-rest-js": "^2.2.0",
+    "@azure/core-auth": "^1.1.4",
     "tslib": "^1.10.0"
   },
   "keywords": [
@@ -20,13 +21,13 @@
   "module": "./esm/synapseManagementClient.js",
   "types": "./esm/synapseManagementClient.d.ts",
   "devDependencies": {
-    "typescript": "^3.5.3",
+    "typescript": "^3.6.0",
     "rollup": "^1.18.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.4.2",
     "uglify-js": "^3.6.0"
   },
-  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/synapse/arm-synapse",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/synapse/arm-synapse",
   "repository": {
     "type": "git",
     "url": "https://github.com/Azure/azure-sdk-for-js.git"

sdk/synapse/arm-synapse/src/models/bigDataPoolsMappers.ts

@@ -17,6 +17,7 @@ export {
   BigDataPoolResourceInfoListResult,
   CmdkeySetup,
   ComponentSetup,
+  CspWorkspaceAdminProperties,
   CustomerManagedKeyDetails,
   CustomSetupBase,
   DataLakeStorageAccountDetails,
@@ -44,6 +45,7 @@ export {
   IntegrationRuntimeSsisProperties,
   IntegrationRuntimeVNetProperties,
   IpFirewallRuleInfo,
+  KekIdentityProperties,
   Key,
   LibraryInfo,
   LibraryRequirements,

sdk/synapse/arm-synapse/src/models/dataMaskingPoliciesMappers.ts

@@ -15,6 +15,7 @@ export {
   BigDataPoolResourceInfo,
   CmdkeySetup,
   ComponentSetup,
+  CspWorkspaceAdminProperties,
   CustomerManagedKeyDetails,
   CustomSetupBase,
   DataLakeStorageAccountDetails,
@@ -42,6 +43,7 @@ export {
   IntegrationRuntimeSsisProperties,
   IntegrationRuntimeVNetProperties,
   IpFirewallRuleInfo,
+  KekIdentityProperties,
   Key,
   LibraryInfo,
   LibraryRequirements,

sdk/synapse/arm-synapse/src/models/dataMaskingRulesMappers.ts

@@ -15,6 +15,7 @@ export {
   BigDataPoolResourceInfo,
   CmdkeySetup,
   ComponentSetup,
+  CspWorkspaceAdminProperties,
   CustomerManagedKeyDetails,
   CustomSetupBase,
   DataLakeStorageAccountDetails,
@@ -43,6 +44,7 @@ export {
   IntegrationRuntimeSsisProperties,
   IntegrationRuntimeVNetProperties,
   IpFirewallRuleInfo,
+  KekIdentityProperties,
   Key,
   LibraryInfo,
   LibraryRequirements,

sdk/synapse/arm-synapse/src/models/extendedSqlPoolBlobAuditingPoliciesMappers.ts

@@ -16,6 +16,7 @@ export {
   CloudError,
   CmdkeySetup,
   ComponentSetup,
+  CspWorkspaceAdminProperties,
   CustomerManagedKeyDetails,
   CustomSetupBase,
   DataLakeStorageAccountDetails,
@@ -41,6 +42,7 @@ export {
   IntegrationRuntimeSsisProperties,
   IntegrationRuntimeVNetProperties,
   IpFirewallRuleInfo,
+  KekIdentityProperties,
   Key,
   LibraryInfo,
   LibraryRequirements,

sdk/synapse/arm-synapse/src/models/index.ts

@@ -225,7 +225,7 @@ export interface BigDataPoolResourceInfo extends TrackedResource {
   nodeSize?: NodeSize;
   /**
    * The kind of nodes that the Big Data pool provides. Possible values include: 'None',
-   * 'MemoryOptimized'
+   * 'MemoryOptimized', 'HardwareAcceleratedFPGA', 'HardwareAcceleratedGPU'
    */
   nodeSizeFamily?: NodeSizeFamily;
   /**
@@ -387,7 +387,7 @@ export interface IpFirewallRuleProperties {
 /**
  * IP firewall rule
  */
-export interface IpFirewallRuleInfo extends BaseResource {
+export interface IpFirewallRuleInfo extends ProxyResource {
   /**
    * The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to
    * startIpAddress
@@ -2264,7 +2264,7 @@ export interface SqlPoolPatchInfo {
  * Configuration for metadata sync
  * @summary Metadata sync configuration
  */
-export interface MetadataSyncConfig extends BaseResource {
+export interface MetadataSyncConfig extends ProxyResource {
   /**
    * Indicates whether the metadata sync is enabled or disabled
    */
@@ -4049,6 +4049,20 @@ export interface WorkspaceKeyDetails {
   keyVaultUrl?: string;
 }
 
+/**
+ * Key encryption key properties
+ */
+export interface KekIdentityProperties {
+  /**
+   * User assigned identity resource Id
+   */
+  userAssignedIdentity?: string;
+  /**
+   * Boolean specifying whether to use system assigned identity or not
+   */
+  useSystemAssignedIdentity?: any;
+}
+
 /**
  * Details of the customer managed key associated with the workspace
  */
@@ -4062,6 +4076,10 @@ export interface CustomerManagedKeyDetails {
    * The key object of the workspace
    */
   key?: WorkspaceKeyDetails;
+  /**
+   * Key encryption key
+   */
+  kekIdentity?: KekIdentityProperties;
 }
 
 /**
@@ -4150,6 +4168,16 @@ export interface PurviewConfiguration {
   purviewResourceId?: string;
 }
 
+/**
+ * Initial workspace AAD admin properties for a CSP subscription
+ */
+export interface CspWorkspaceAdminProperties {
+  /**
+   * AAD object ID of initial workspace admin
+   */
+  initialWorkspaceAdminObjectId?: string;
+}
+
 /**
  * The workspace managed identity
  */
@@ -4248,10 +4276,14 @@ export interface Workspace extends TrackedResource {
    */
   readonly adlaResourceId?: string;
   /**
-   * Enable or Disable pubic network access to workspace. Possible values include: 'Enabled',
+   * Enable or Disable public network access to workspace. Possible values include: 'Enabled',
    * 'Disabled'
    */
   publicNetworkAccess?: WorkspacePublicNetworkAccess;
+  /**
+   * Initial workspace AAD admin properties for a CSP subscription
+   */
+  cspWorkspaceAdminProperties?: CspWorkspaceAdminProperties;
   /**
    * Identity of the workspace
    */
@@ -4261,7 +4293,7 @@ export interface Workspace extends TrackedResource {
 /**
  * Workspace active directory administrator
  */
-export interface WorkspaceAadAdminInfo extends BaseResource {
+export interface WorkspaceAadAdminInfo extends ProxyResource {
   /**
    * Tenant ID of the workspace active directory administrator
    */
@@ -4318,7 +4350,7 @@ export interface WorkspacePatchInfo {
    */
   encryption?: EncryptionDetails;
   /**
-   * Enable or Disable pubic network access to workspace. Possible values include: 'Enabled',
+   * Enable or Disable public network access to workspace. Possible values include: 'Enabled',
    * 'Disabled'
    */
   publicNetworkAccess?: WorkspacePublicNetworkAccess;
@@ -5055,11 +5087,12 @@ export type NodeSize = 'None' | 'Small' | 'Medium' | 'Large' | 'XLarge' | 'XXLar
 
 /**
  * Defines values for NodeSizeFamily.
- * Possible values include: 'None', 'MemoryOptimized'
+ * Possible values include: 'None', 'MemoryOptimized', 'HardwareAcceleratedFPGA',
+ * 'HardwareAcceleratedGPU'
  * @readonly
  * @enum {string}
  */
-export type NodeSizeFamily = 'None' | 'MemoryOptimized';
+export type NodeSizeFamily = 'None' | 'MemoryOptimized' | 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU';
 
 /**
  * Defines values for ProvisioningState.
@@ -6817,6 +6850,26 @@ export type PrivateEndpointConnectionsPrivateLinkHubListResponse = PrivateEndpoi
     };
 };
 
+/**
+ * Contains response data for the get operation.
+ */
+export type PrivateEndpointConnectionsPrivateLinkHubGetResponse = PrivateEndpointConnectionForPrivateLinkHub & {
+  /**
+   * The underlying HTTP response.
+   */
+  _response: msRest.HttpResponse & {
+      /**
+       * The response body as text (string format)
+       */
+      bodyAsText: string;
+
+      /**
+       * The response body as parsed JSON or XML
+       */
+      parsedBody: PrivateEndpointConnectionForPrivateLinkHub;
+    };
+};
+
 /**
  * Contains response data for the listNext operation.
  */