forked from Azure/azure-sdk-for-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
newrelicobservability release (Azure#25351)
- Loading branch information
1 parent
aa27614
commit 7452042
Showing
110 changed files
with
12,942 additions
and
3 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
sdk/newrelicobservability/arm-newrelicobservability/CHANGELOG.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release History | ||
|
||
## 1.0.0-beta.1 (2023-03-23) | ||
|
||
The package of @azure/arm-newrelicobservability is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart). |
21 changes: 21 additions & 0 deletions
21
sdk/newrelicobservability/arm-newrelicobservability/LICENSE
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2023 Microsoft | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
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. |
109 changes: 109 additions & 0 deletions
109
sdk/newrelicobservability/arm-newrelicobservability/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# Azure NewRelicObservability client library for JavaScript | ||
|
||
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure NewRelicObservability client. | ||
|
||
|
||
|
||
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/newrelicobservability/arm-newrelicobservability) | | ||
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-newrelicobservability) | | ||
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-newrelicobservability?view=azure-node-preview) | | ||
[Samples](https://github.com/Azure-Samples/azure-samples-js-management) | ||
|
||
## Getting started | ||
|
||
### Currently supported environments | ||
|
||
- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule) | ||
- Latest versions of Safari, Chrome, Edge and Firefox. | ||
|
||
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. | ||
|
||
### Prerequisites | ||
|
||
- An [Azure subscription][azure_sub]. | ||
|
||
### Install the `@azure/arm-newrelicobservability` package | ||
|
||
Install the Azure NewRelicObservability client library for JavaScript with `npm`: | ||
|
||
```bash | ||
npm install @azure/arm-newrelicobservability | ||
``` | ||
|
||
### Create and authenticate a `NewRelicObservability` | ||
|
||
To create a client object to access the Azure NewRelicObservability API, you will need the `endpoint` of your Azure NewRelicObservability resource and a `credential`. The Azure NewRelicObservability client can use Azure Active Directory credentials to authenticate. | ||
You can find the endpoint for your Azure NewRelicObservability 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). | ||
|
||
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package: | ||
|
||
```bash | ||
npm install @azure/identity | ||
``` | ||
|
||
You will also need to **register a new AAD application and grant access to Azure NewRelicObservability** 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 { NewRelicObservability } = require("@azure/arm-newrelicobservability"); | ||
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 NewRelicObservability(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 NewRelicObservability(credential, subscriptionId); | ||
``` | ||
|
||
|
||
### 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 | ||
|
||
### NewRelicObservability | ||
|
||
`NewRelicObservability` is the primary interface for developers using the Azure NewRelicObservability client library. Explore the methods on this client object to understand the different features of the Azure NewRelicObservability service that you can access. | ||
|
||
## Troubleshooting | ||
|
||
### Logging | ||
|
||
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: | ||
|
||
```javascript | ||
const { setLogLevel } = require("@azure/logger"); | ||
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 | ||
|
||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code. | ||
|
||
## Related projects | ||
|
||
- [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%2Fnewrelicobservability%2Farm-newrelicobservability%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 | ||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential |
8 changes: 8 additions & 0 deletions
8
sdk/newrelicobservability/arm-newrelicobservability/_meta.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"commit": "fc450164d4c1ed7944efd86df569fcc118cb8fbc", | ||
"readme": "specification/newrelic/resource-manager/readme.md", | ||
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\newrelic\\resource-manager\\readme.md --use=@autorest/[email protected] --generate-sample=true", | ||
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git", | ||
"release_tool": "@azure-tools/[email protected]", | ||
"use": "@autorest/[email protected]" | ||
} |
31 changes: 31 additions & 0 deletions
31
sdk/newrelicobservability/arm-newrelicobservability/api-extractor.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"$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" | ||
}, | ||
"dtsRollup": { | ||
"enabled": true, | ||
"untrimmedFilePath": "", | ||
"publicTrimmedFilePath": "./types/arm-newrelicobservability.d.ts" | ||
}, | ||
"messages": { | ||
"tsdocMessageReporting": { | ||
"default": { | ||
"logLevel": "none" | ||
} | ||
}, | ||
"extractorMessageReporting": { | ||
"ae-missing-release-tag": { | ||
"logLevel": "none" | ||
}, | ||
"ae-unresolved-link": { | ||
"logLevel": "none" | ||
} | ||
} | ||
} | ||
} |
123 changes: 123 additions & 0 deletions
123
sdk/newrelicobservability/arm-newrelicobservability/package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
{ | ||
"name": "@azure/arm-newrelicobservability", | ||
"sdk-type": "mgmt", | ||
"author": "Microsoft Corporation", | ||
"description": "A generated SDK for NewRelicObservability.", | ||
"version": "1.0.0-beta.1", | ||
"engines": { | ||
"node": ">=14.0.0" | ||
}, | ||
"dependencies": { | ||
"@azure/core-lro": "^2.5.0", | ||
"@azure/abort-controller": "^1.0.0", | ||
"@azure/core-paging": "^1.2.0", | ||
"@azure/core-client": "^1.7.0", | ||
"@azure/core-auth": "^1.3.0", | ||
"@azure/core-rest-pipeline": "^1.8.0", | ||
"tslib": "^2.2.0" | ||
}, | ||
"keywords": [ | ||
"node", | ||
"azure", | ||
"typescript", | ||
"browser", | ||
"isomorphic" | ||
], | ||
"license": "MIT", | ||
"main": "./dist/index.js", | ||
"module": "./dist-esm/src/index.js", | ||
"types": "./types/arm-newrelicobservability.d.ts", | ||
"devDependencies": { | ||
"@microsoft/api-extractor": "^7.31.1", | ||
"@rollup/plugin-commonjs": "^24.0.0", | ||
"@rollup/plugin-json": "^6.0.0", | ||
"@rollup/plugin-multi-entry": "^6.0.0", | ||
"@rollup/plugin-node-resolve": "^13.1.3", | ||
"mkdirp": "^2.1.2", | ||
"rollup": "^2.66.1", | ||
"rollup-plugin-sourcemaps": "^0.6.3", | ||
"typescript": "~4.8.0", | ||
"uglify-js": "^3.4.9", | ||
"rimraf": "^3.0.0", | ||
"dotenv": "^16.0.0", | ||
"@azure/identity": "^2.0.1", | ||
"@azure-tools/test-recorder": "^3.0.0", | ||
"@azure-tools/test-credential": "^1.0.0", | ||
"mocha": "^7.1.1", | ||
"@types/chai": "^4.2.8", | ||
"chai": "^4.2.0", | ||
"cross-env": "^7.0.2", | ||
"@types/node": "^14.0.0", | ||
"@azure/dev-tool": "^1.0.0" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/Azure/azure-sdk-for-js.git" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/Azure/azure-sdk-for-js/issues" | ||
}, | ||
"files": [ | ||
"dist/**/*.js", | ||
"dist/**/*.js.map", | ||
"dist/**/*.d.ts", | ||
"dist/**/*.d.ts.map", | ||
"dist-esm/**/*.js", | ||
"dist-esm/**/*.js.map", | ||
"dist-esm/**/*.d.ts", | ||
"dist-esm/**/*.d.ts.map", | ||
"src/**/*.ts", | ||
"README.md", | ||
"LICENSE", | ||
"rollup.config.js", | ||
"tsconfig.json", | ||
"review/*", | ||
"CHANGELOG.md", | ||
"types/*" | ||
], | ||
"scripts": { | ||
"build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api", | ||
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js", | ||
"prepack": "npm run build", | ||
"pack": "npm pack 2>&1", | ||
"extract-api": "api-extractor run --local", | ||
"lint": "echo skipped", | ||
"audit": "echo skipped", | ||
"clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log", | ||
"build:node": "echo skipped", | ||
"build:browser": "echo skipped", | ||
"build:test": "echo skipped", | ||
"build:samples": "echo skipped.", | ||
"check-format": "echo skipped", | ||
"execute:samples": "echo skipped", | ||
"format": "echo skipped", | ||
"test": "npm run integration-test", | ||
"test:node": "echo skipped", | ||
"test:browser": "echo skipped", | ||
"unit-test": "npm run unit-test:node && npm run unit-test:browser", | ||
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node", | ||
"unit-test:browser": "echo skipped", | ||
"integration-test": "npm run integration-test:node && npm run integration-test:browser", | ||
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'", | ||
"integration-test:browser": "echo skipped" | ||
}, | ||
"sideEffects": false, | ||
"//metadata": { | ||
"constantPaths": [ | ||
{ | ||
"path": "src/newRelicObservability.ts", | ||
"prefix": "packageDetails" | ||
} | ||
] | ||
}, | ||
"autoPublish": true, | ||
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/newrelicobservability/arm-newrelicobservability", | ||
"//sampleConfiguration": { | ||
"productName": "", | ||
"productSlugs": [ | ||
"azure" | ||
], | ||
"disableDocsMs": true, | ||
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-newrelicobservability?view=azure-node-preview" | ||
} | ||
} |
Oops, something went wrong.