Skip to content

[AutoPR default] [TSP Migration]--datadog #15565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 40 additions & 40 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 0 additions & 61 deletions sdk/datadog/arm-datadog/CHANGELOG.md

This file was deleted.

2 changes: 1 addition & 1 deletion sdk/datadog/arm-datadog/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ 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.
SOFTWARE.
52 changes: 25 additions & 27 deletions sdk/datadog/arm-datadog/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Azure Microsoft Datadog client library for JavaScript
# Azure Datadog client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Microsoft Datadog client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Datadog client.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/datadog/arm-datadog) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-datadog) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-datadog) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)


Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/datadog/arm-datadog)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-datadog)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-datadog?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/datadog/arm-datadog/samples)

## Getting started

Expand All @@ -22,16 +26,16 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-datadog` package

Install the Azure Microsoft Datadog client library for JavaScript with `npm`:
Install the Azure Datadog client library for JavaScript with `npm`:

```bash
npm install @azure/arm-datadog
```

### Create and authenticate a `MicrosoftDatadogClient`
### Create and authenticate a `DatadogClient`

To create a client object to access the Azure Microsoft Datadog API, you will need the `endpoint` of your Azure Microsoft Datadog resource and a `credential`. The Azure Microsoft Datadog client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Microsoft Datadog resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure Datadog API, you will need the `endpoint` of your Azure Datadog resource and a `credential`. The Azure Datadog client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Datadog 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).

Expand All @@ -41,44 +45,42 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure Microsoft Datadog** 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`.
You will also need to **register a new AAD application and grant access to Azure Datadog** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:ReadmeSampleCreateClient_Node
import { MicrosoftDatadogClient } from "@azure/arm-datadog";
import { DatadogClient } from "@azure/arm-datadog";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new MicrosoftDatadogClient(new DefaultAzureCredential(), subscriptionId);
const client = new DatadogClient(new DefaultAzureCredential(), subscriptionId);
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { MicrosoftDatadogClient } from "@azure/arm-datadog";
import { DatadogClient } from "@azure/arm-datadog";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new MicrosoftDatadogClient(credential, subscriptionId);
clientId: "<YOUR_CLIENT_ID>"
});
const client = new DatadogClient(credential, subscriptionId);
```

### JavaScript Bundle

### JavaScript Bundle
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts

### MicrosoftDatadogClient
### DatadogClient

`MicrosoftDatadogClient` is the primary interface for developers using the Azure Microsoft Datadog client library. Explore the methods on this client object to understand the different features of the Azure Microsoft Datadog service that you can access.
`DatadogClient` is the primary interface for developers using the Azure Datadog client library. Explore the methods on this client object to understand the different features of the Azure Datadog service that you can access.

## Troubleshooting

Expand All @@ -96,7 +98,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur

## 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.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/datadog/arm-datadog/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -106,10 +108,6 @@ If you'd like to contribute to this library, please read the [contributing guide

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)



[azure_cli]: https://learn.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
Expand Down
8 changes: 0 additions & 8 deletions sdk/datadog/arm-datadog/_meta.json

This file was deleted.

6 changes: 0 additions & 6 deletions sdk/datadog/arm-datadog/assets.json

This file was deleted.

14 changes: 14 additions & 0 deletions sdk/datadog/arm-datadog/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";

export default azsdkEslint.config([
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn",
},
},
]);
Loading