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-deviceregistry] Update tsp config for Dec release #13121

Closed
wants to merge 1 commit into from
Closed
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
47 changes: 30 additions & 17 deletions common/config/rush/pnpm-lock.yaml

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

2 changes: 2 additions & 0 deletions sdk/core/core-rest-pipeline/review/core-rest-pipeline.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,8 @@ export type RequestBodyType = NodeJS.ReadableStream | (() => NodeJS.ReadableStre
// @public
export class RestError extends Error {
constructor(message: string, options?: RestErrorOptions);
// (undocumented)
[x: symbol]: () => string;
code?: string;
details?: unknown;
static readonly PARSE_ERROR: string;
Expand Down
12 changes: 2 additions & 10 deletions sdk/deviceregistry/arm-deviceregistry/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
# Release History

## 1.0.0-beta.2 (Unreleased)
## 1.0.0 (2024-12-16)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes

## 1.0.0-beta.1 (2024-04-15)

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

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

Microsoft.DeviceRegistry Resource Provider management API.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceregistry/arm-deviceregistry) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-deviceregistry) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-deviceregistry?view=azure-node-preview) |
[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/deviceregistry/arm-deviceregistry)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-deviceregistry)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-deviceregistry?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceregistry/arm-deviceregistry/samples)

## Getting started

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

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

Install the Azure DeviceRegistryManagement client library for JavaScript with `npm`:
Install the Azure DeviceRegistry client library for JavaScript with `npm`:

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

### Create and authenticate a `DeviceRegistryManagementClient`
### Create and authenticate a `DeviceRegistryClient`

To create a client object to access the Azure DeviceRegistryManagement API, you will need the `endpoint` of your Azure DeviceRegistryManagement resource and a `credential`. The Azure DeviceRegistryManagement client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure DeviceRegistryManagement resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure DeviceRegistry API, you will need the `endpoint` of your Azure DeviceRegistry resource and a `credential`. The Azure DeviceRegistry client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure DeviceRegistry 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 +45,24 @@ 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 DeviceRegistryManagement** 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 DeviceRegistry** 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://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { DeviceRegistryManagementClient } = require("@azure/arm-deviceregistry");
const { DeviceRegistryClient } = require("@azure/arm-deviceregistry");
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 DeviceRegistryManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new DeviceRegistryClient(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 DeviceRegistryManagementClient(credential, subscriptionId);
// const client = new DeviceRegistryClient(credential, subscriptionId);
```


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

## Key concepts

### DeviceRegistryManagementClient
### DeviceRegistryClient

`DeviceRegistryManagementClient` is the primary interface for developers using the Azure DeviceRegistryManagement client library. Explore the methods on this client object to understand the different features of the Azure DeviceRegistryManagement service that you can access.
`DeviceRegistryClient` is the primary interface for developers using the Azure DeviceRegistry client library. Explore the methods on this client object to understand the different features of the Azure DeviceRegistry service that you can access.

## Troubleshooting

Expand All @@ -89,7 +90,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/deviceregistry/arm-deviceregistry/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -99,10 +100,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%2Fdeviceregistry%2Farm-deviceregistry%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/deviceregistry/arm-deviceregistry/_meta.json

This file was deleted.

27 changes: 7 additions & 20 deletions sdk/deviceregistry/arm-deviceregistry/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-deviceregistry.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/deviceregistry/arm-deviceregistry/assets.json

This file was deleted.

17 changes: 17 additions & 0 deletions sdk/deviceregistry/arm-deviceregistry/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
Loading