Skip to content
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

[AutoPR @azure/arm-networkanalytics] support sample gen for ts emitter #12874

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
28 changes: 25 additions & 3 deletions common/config/rush/pnpm-lock.yaml

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

73 changes: 65 additions & 8 deletions sdk/networkanalytics/arm-networkanalytics/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,72 @@
# Release History

## 1.0.1 (Unreleased)

## 2.0.0 (2024-11-14)
### Features Added

### Breaking Changes
- Added operation DataProductsOperations.create
- Added operation DataProductsOperations.delete
- Added operation DataProductsOperations.update
- Added operation DataTypesOperations.create
- Added operation DataTypesOperations.delete
- Added operation DataTypesOperations.deleteData
- Added operation DataTypesOperations.update
- Added Interface ManagedServiceIdentityV4
- Added Interface NetworkAnalyticsClientOptionalParams
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface RestorePollerOptions
- Added Class NetworkAnalyticsClient
- Added Type Alias ContinuablePage
- Enum KnownManagedServiceIdentityType has a new value SystemAndUserAssigned
- Enum KnownOrigin has a new value "user,system"
- Enum KnownOrigin has a new value system
- Enum KnownOrigin has a new value user
- Enum KnownVersions has a new value v2023_11_15
- Added function restorePoller

### Bugs Fixed

### Other Changes
### Breaking Changes

- Removed operation DataProducts.beginCreate
- Removed operation DataProducts.beginCreateAndWait
- Removed operation DataProducts.beginDelete
- Removed operation DataProducts.beginDeleteAndWait
- Removed operation DataProducts.beginUpdate
- Removed operation DataProducts.beginUpdateAndWait
- Removed operation DataTypes.beginCreate
- Removed operation DataTypes.beginCreateAndWait
- Removed operation DataTypes.beginDelete
- Removed operation DataTypes.beginDeleteAndWait
- Removed operation DataTypes.beginDeleteData
- Removed operation DataTypes.beginDeleteDataAndWait
- Removed operation DataTypes.beginUpdate
- Removed operation DataTypes.beginUpdateAndWait
- Deleted Class MicrosoftNetworkAnalytics
- Interface DataProductsCreateOptionalParams no longer has parameter resumeFrom
- Interface DataProductsDeleteOptionalParams no longer has parameter resumeFrom
- Interface DataProductsUpdateOptionalParams no longer has parameter resumeFrom
- Interface DataTypesCreateOptionalParams no longer has parameter resumeFrom
- Interface DataTypesDeleteDataOptionalParams no longer has parameter resumeFrom
- Interface DataTypesDeleteOptionalParams no longer has parameter resumeFrom
- Interface DataTypesUpdateOptionalParams no longer has parameter resumeFrom
- Type of parameter identity of interface DataProduct is changed from ManagedServiceIdentity to ManagedServiceIdentityV4
- Type of parameter identity of interface DataProductUpdate is changed from ManagedServiceIdentity to ManagedServiceIdentityV4
- Type of parameter tags of interface DataProductUpdate is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter info of interface ErrorAdditionalInfo is changed from Record<string, unknown> to Record<string, any>
- Type of parameter tags of interface TrackedResource is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Removed Enum KnownBypass
- Enum KnownManagedServiceIdentityType no longer has value SystemAssignedUserAssigned
- Enum KnownOrigin no longer has value System
- Enum KnownOrigin no longer has value User
- Enum KnownOrigin no longer has value UserSystem
- Enum KnownVersions no longer has value V20231115
- Removed function getContinuationToken


## 1.0.0 (2024-01-24)

The package of @azure/arm-networkanalytics is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
The package of @azure/arm-networkanalytics is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
39 changes: 16 additions & 23 deletions sdk/networkanalytics/arm-networkanalytics/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Azure MicrosoftNetworkAnalytics client library for JavaScript
# Azure NetworkAnalytics client library for JavaScript

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



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

- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-networkanalytics)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-networkanalytics?view=azure-node-preview)

## Getting started

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

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

Install the Azure MicrosoftNetworkAnalytics client library for JavaScript with `npm`:
Install the Azure NetworkAnalytics client library for JavaScript with `npm`:

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

### Create and authenticate a `MicrosoftNetworkAnalytics`
### Create and authenticate a `NetworkAnalyticsClient`

To create a client object to access the Azure MicrosoftNetworkAnalytics API, you will need the `endpoint` of your Azure MicrosoftNetworkAnalytics resource and a `credential`. The Azure MicrosoftNetworkAnalytics client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure MicrosoftNetworkAnalytics resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure NetworkAnalytics API, you will need the `endpoint` of your Azure NetworkAnalytics resource and a `credential`. The Azure NetworkAnalytics client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure NetworkAnalytics 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 @@ -43,25 +43,25 @@ 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 MicrosoftNetworkAnalytics** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
You will also need to **register a new AAD application and grant access to Azure NetworkAnalytics** 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`.

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

```javascript
const { MicrosoftNetworkAnalytics } = require("@azure/arm-networkanalytics");
const { NetworkAnalyticsClient } = require("@azure/arm-networkanalytics");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new MicrosoftNetworkAnalytics(new DefaultAzureCredential(), subscriptionId);
const client = new NetworkAnalyticsClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new MicrosoftNetworkAnalytics(credential, subscriptionId);
// const client = new NetworkAnalyticsClient(credential, subscriptionId);
```


Expand All @@ -70,9 +70,9 @@ To use this client library in the browser, first you need to use a bundler. For

## Key concepts

### MicrosoftNetworkAnalytics
### NetworkAnalyticsClient

`MicrosoftNetworkAnalytics` is the primary interface for developers using the Azure MicrosoftNetworkAnalytics client library. Explore the methods on this client object to understand the different features of the Azure MicrosoftNetworkAnalytics service that you can access.
`NetworkAnalyticsClient` is the primary interface for developers using the Azure NetworkAnalytics client library. Explore the methods on this client object to understand the different features of the Azure NetworkAnalytics service that you can access.

## Troubleshooting

Expand All @@ -87,9 +87,6 @@ setLogLevel("info");

For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

## 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.

## Contributing

Expand All @@ -99,10 +96,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)

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fnetworkanalytics%2Farm-networkanalytics%2FREADME.png)

[azure_cli]: https://docs.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/networkanalytics/arm-networkanalytics/_meta.json

This file was deleted.

27 changes: 7 additions & 20 deletions sdk/networkanalytics/arm-networkanalytics/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,18 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
"docModel": { "enabled": true },
"apiReport": { "enabled": true, "reportFolder": "./review" },
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-networkanalytics.d.ts"
},
"messages": {
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
},
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
"extractorMessageReporting": {
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
"ae-missing-release-tag": { "logLevel": "none" },
"ae-unresolved-link": { "logLevel": "none" }
}
}
}
}
6 changes: 0 additions & 6 deletions sdk/networkanalytics/arm-networkanalytics/assets.json

This file was deleted.

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

export default [
...azsdkEslint.configs.recommended,
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-apiextractor-json-types": "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-module": "off",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn"
}
}
];
Loading