diff --git a/sdk/synapse/arm-synapse/README.md b/sdk/synapse/arm-synapse/README.md index 1bda5ed3936c..96077b7c3741 100644 --- a/sdk/synapse/arm-synapse/README.md +++ b/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 +- Node.js version 8.x.x or higher - Browser JavaScript -### 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 @azure/arm-synapse sample - - + diff --git a/sdk/synapse/arm-synapse/package.json b/sdk/synapse/arm-synapse/package.json index 110cec07f695..db64bd609cd9 100644 --- a/sdk/synapse/arm-synapse/package.json +++ b/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,7 +21,7 @@ "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", diff --git a/sdk/synapse/arm-synapse/src/models/index.ts b/sdk/synapse/arm-synapse/src/models/index.ts index dd515f83cf7b..1264775d42f0 100644 --- a/sdk/synapse/arm-synapse/src/models/index.ts +++ b/sdk/synapse/arm-synapse/src/models/index.ts @@ -4248,7 +4248,7 @@ 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; @@ -4318,7 +4318,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; @@ -6817,6 +6817,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. */ diff --git a/sdk/synapse/arm-synapse/src/operations/privateEndpointConnectionsPrivateLinkHub.ts b/sdk/synapse/arm-synapse/src/operations/privateEndpointConnectionsPrivateLinkHub.ts index c4b1ebfe2946..264bb96c6361 100644 --- a/sdk/synapse/arm-synapse/src/operations/privateEndpointConnectionsPrivateLinkHub.ts +++ b/sdk/synapse/arm-synapse/src/operations/privateEndpointConnectionsPrivateLinkHub.ts @@ -57,6 +57,42 @@ export class PrivateEndpointConnectionsPrivateLinkHub { callback) as Promise; } + /** + * Get all PrivateEndpointConnection in the PrivateLinkHub by name + * @param resourceGroupName The name of the resource group. The name is case insensitive. + * @param privateLinkHubName Name of the privateLinkHub + * @param privateEndpointConnectionName Name of the privateEndpointConnection + * @param [options] The optional parameters + * @returns Promise + */ + get(resourceGroupName: string, privateLinkHubName: string, privateEndpointConnectionName: string, options?: msRest.RequestOptionsBase): Promise; + /** + * @param resourceGroupName The name of the resource group. The name is case insensitive. + * @param privateLinkHubName Name of the privateLinkHub + * @param privateEndpointConnectionName Name of the privateEndpointConnection + * @param callback The callback + */ + get(resourceGroupName: string, privateLinkHubName: string, privateEndpointConnectionName: string, callback: msRest.ServiceCallback): void; + /** + * @param resourceGroupName The name of the resource group. The name is case insensitive. + * @param privateLinkHubName Name of the privateLinkHub + * @param privateEndpointConnectionName Name of the privateEndpointConnection + * @param options The optional parameters + * @param callback The callback + */ + get(resourceGroupName: string, privateLinkHubName: string, privateEndpointConnectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; + get(resourceGroupName: string, privateLinkHubName: string, privateEndpointConnectionName: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + resourceGroupName, + privateLinkHubName, + privateEndpointConnectionName, + options + }, + getOperationSpec, + callback) as Promise; + } + /** * Get all PrivateEndpointConnections in the PrivateLinkHub * @param nextPageLink The NextLink from the previous successful call to List operation. @@ -113,6 +149,32 @@ const listOperationSpec: msRest.OperationSpec = { serializer }; +const getOperationSpec: msRest.OperationSpec = { + httpMethod: "GET", + path: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}/privateEndpointConnections/{privateEndpointConnectionName}", + urlParameters: [ + Parameters.subscriptionId, + Parameters.resourceGroupName, + Parameters.privateLinkHubName, + Parameters.privateEndpointConnectionName + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + responses: { + 200: { + bodyMapper: Mappers.PrivateEndpointConnectionForPrivateLinkHub + }, + default: { + bodyMapper: Mappers.ErrorResponse + } + }, + serializer +}; + const listNextOperationSpec: msRest.OperationSpec = { httpMethod: "GET", baseUrl: "https://management.azure.com", diff --git a/sdk/synapse/arm-synapse/src/synapseManagementClient.ts b/sdk/synapse/arm-synapse/src/synapseManagementClient.ts index b2adedb6fd50..1c289b9a605d 100644 --- a/sdk/synapse/arm-synapse/src/synapseManagementClient.ts +++ b/sdk/synapse/arm-synapse/src/synapseManagementClient.ts @@ -8,6 +8,7 @@ */ import * as msRest from "@azure/ms-rest-js"; +import { TokenCredential } from "@azure/core-auth"; import * as Models from "./models"; import * as Mappers from "./models/mappers"; import * as operations from "./operations"; @@ -80,11 +81,16 @@ class SynapseManagementClient extends SynapseManagementClientContext { /** * Initializes a new instance of the SynapseManagementClient 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 The ID of the target subscription. * @param [options] The parameter options */ - constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.SynapseManagementClientOptions) { + constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.SynapseManagementClientOptions) { super(credentials, subscriptionId, options); this.bigDataPools = new operations.BigDataPools(this); this.operations = new operations.Operations(this); diff --git a/sdk/synapse/arm-synapse/src/synapseManagementClientContext.ts b/sdk/synapse/arm-synapse/src/synapseManagementClientContext.ts index 5e44f5084cde..59a509b96aff 100644 --- a/sdk/synapse/arm-synapse/src/synapseManagementClientContext.ts +++ b/sdk/synapse/arm-synapse/src/synapseManagementClientContext.ts @@ -10,22 +10,28 @@ import * as Models from "./models"; import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; +import { TokenCredential } from "@azure/core-auth"; const packageName = "@azure/arm-synapse"; const packageVersion = "5.1.0"; export class SynapseManagementClientContext extends msRestAzure.AzureServiceClient { - credentials: msRest.ServiceClientCredentials; + credentials: msRest.ServiceClientCredentials | TokenCredential; subscriptionId: string; apiVersion?: string; /** * Initializes a new instance of the SynapseManagementClient 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 The ID of the target subscription. * @param [options] The parameter options */ - constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.SynapseManagementClientOptions) { + constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.SynapseManagementClientOptions) { if (credentials == undefined) { throw new Error('\'credentials\' cannot be null.'); } @@ -43,7 +49,7 @@ export class SynapseManagementClientContext extends msRestAzure.AzureServiceClie super(credentials, options); - this.apiVersion = '2021-03-01'; + this.apiVersion = '2021-04-01-preview'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";