Skip to content

Commit

Permalink
Revert "arm-datadog-v4 (Azure#15558)" (Azure#15559)
Browse files Browse the repository at this point in the history
This reverts commit 761d3cb.
  • Loading branch information
colawwj authored Jun 4, 2021
1 parent 761d3cb commit 1fab5f5
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 76 deletions.
99 changes: 44 additions & 55 deletions sdk/datadog/arm-datadog/README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,89 @@
## Azure MicrosoftDatadogClient SDK for JavaScript

This package contains an isomorphic SDK (runs both in node.js and in browsers) for MicrosoftDatadogClient.
This package contains an isomorphic SDK for MicrosoftDatadogClient.

### Currently supported environments

- Node.js version 8.x.x or higher
- Node.js version 6.x.x or higher
- Browser JavaScript

### Prerequisites
### How to Install

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-datadog` 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 --save @azure/arm-datadog @azure/identity
npm install @azure/arm-datadog
```

> **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

- 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.
#### nodejs - client creation and list marketplaceAgreements as an example written in TypeScript.

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.
##### Install @azure/ms-rest-nodeauth

#### nodejs - Authentication, client creation, and list marketplaceAgreements as an example written in JavaScript.
- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
```bash
npm install @azure/ms-rest-nodeauth@"^3.0.0"
```

##### Sample code

```javascript
const { DefaultAzureCredential } = require("@azure/identity");
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");
const { MicrosoftDatadogClient } = require("@azure/arm-datadog");
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 MicrosoftDatadogClient(creds, subscriptionId);

client.marketplaceAgreements.list().then((result) => {
console.log("The result is:");
console.log(result);
msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new MicrosoftDatadogClient(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

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.
```bash
npm install @azure/ms-rest-browserauth
```

##### Sample code

- index.html
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-datadog 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/identity/dist/index.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/arm-datadog/dist/arm-datadog.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(
{
const authManager = new msAuth.AuthManager({
clientId: "<client id for your Azure AD app>",
tenantId: "<optional tenant for your organization>"
tenant: "<optional tenant for your organization>"
});
const client = new Azure.ArmDatadog.MicrosoftDatadogClient(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);
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmDatadog.MicrosoftDatadogClient(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);
});
});
</script>
</head>
Expand Down
7 changes: 3 additions & 4 deletions sdk/datadog/arm-datadog/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
"description": "MicrosoftDatadogClient Library with typescript type definitions for node.js and browser.",
"version": "2.0.0",
"dependencies": {
"@azure/ms-rest-azure-js": "^2.1.0",
"@azure/ms-rest-js": "^2.2.0",
"@azure/core-auth": "^1.1.4",
"@azure/ms-rest-azure-js": "^2.0.1",
"@azure/ms-rest-js": "^2.0.4",
"tslib": "^1.10.0"
},
"keywords": [
Expand All @@ -21,7 +20,7 @@
"module": "./esm/microsoftDatadogClient.js",
"types": "./esm/microsoftDatadogClient.d.ts",
"devDependencies": {
"typescript": "^3.6.0",
"typescript": "^3.5.3",
"rollup": "^1.18.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
Expand Down
10 changes: 2 additions & 8 deletions sdk/datadog/arm-datadog/src/microsoftDatadogClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
*/

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";
Expand All @@ -25,16 +24,11 @@ class MicrosoftDatadogClient extends MicrosoftDatadogClientContext {

/**
* Initializes a new instance of the MicrosoftDatadogClient class.
* @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 credentials Credentials needed for the client to connect to Azure.
* @param subscriptionId The ID of the target subscription.
* @param [options] The parameter options
*/
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.MicrosoftDatadogClientOptions) {
constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.MicrosoftDatadogClientOptions) {
super(credentials, subscriptionId, options);
this.marketplaceAgreements = new operations.MarketplaceAgreements(this);
this.monitors = new operations.Monitors(this);
Expand Down
12 changes: 3 additions & 9 deletions sdk/datadog/arm-datadog/src/microsoftDatadogClientContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,24 @@

import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
import { TokenCredential } from "@azure/core-auth";
import * as msRestAzure from "@azure/ms-rest-azure-js";

const packageName = "@azure/arm-datadog";
const packageVersion = "2.0.0";

export class MicrosoftDatadogClientContext extends msRestAzure.AzureServiceClient {
credentials: msRest.ServiceClientCredentials | TokenCredential;
credentials: msRest.ServiceClientCredentials;
apiVersion?: string;
subscriptionId: string;

/**
* Initializes a new instance of the MicrosoftDatadogClient class.
* @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 credentials Credentials needed for the client to connect to Azure.
* @param subscriptionId The ID of the target subscription.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials | TokenCredential,
credentials: msRest.ServiceClientCredentials,
subscriptionId: string,
options?: Models.MicrosoftDatadogClientOptions
) {
Expand Down

0 comments on commit 1fab5f5

Please sign in to comment.