forked from Azure/azure-sdk-for-js
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 31921 in Azure/azure-rest-api-specs
Merge b10bb3a26d6df59188c0779c25c8bbbc8ca6bb76 into 416353cabfea1fc7a1c7c46ba3340408a2618de1
- Loading branch information
SDKAuto
committed
Dec 18, 2024
1 parent
6d5b261
commit ec5f22f
Showing
30 changed files
with
2,488 additions
and
0 deletions.
There are no files selected for viewing
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) 2024 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. |
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,102 @@ | ||
# Azure Storage client library for JavaScript | ||
|
||
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Storage client. | ||
|
||
|
||
|
||
Key links: | ||
|
||
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/qumulo/arm-qumulo) | ||
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-qumulo) | ||
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-qumulo?view=azure-node-preview) | ||
|
||
## 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-qumulo` package | ||
|
||
Install the Azure Storage client library for JavaScript with `npm`: | ||
|
||
```bash | ||
npm install @azure/arm-qumulo | ||
``` | ||
|
||
### Create and authenticate a `StorageClient` | ||
|
||
To create a client object to access the Azure Storage API, you will need the `endpoint` of your Azure Storage resource and a `credential`. The Azure Storage client can use Azure Active Directory credentials to authenticate. | ||
You can find the endpoint for your Azure Storage 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 Storage** 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 { StorageClient } = require("@azure/arm-qumulo"); | ||
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 StorageClient(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 StorageClient(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 | ||
|
||
### StorageClient | ||
|
||
`StorageClient` is the primary interface for developers using the Azure Storage client library. Explore the methods on this client object to understand the different features of the Azure Storage 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). | ||
|
||
|
||
## 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) | ||
|
||
[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 |
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,18 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"mainEntryPointFilePath": "./dist/esm/index.d.ts", | ||
"docModel": { "enabled": true }, | ||
"apiReport": { "enabled": true, "reportFolder": "./review" }, | ||
"dtsRollup": { | ||
"enabled": true, | ||
"untrimmedFilePath": "", | ||
"publicTrimmedFilePath": "./types/arm-qumulo.d.ts" | ||
}, | ||
"messages": { | ||
"tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
"extractorMessageReporting": { | ||
"ae-missing-release-tag": { "logLevel": "none" }, | ||
"ae-unresolved-link": { "logLevel": "none" } | ||
} | ||
} | ||
} |
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,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" | ||
} | ||
} | ||
]; |
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,91 @@ | ||
{ | ||
"name": "@azure/arm-qumulo", | ||
"version": "1.0.0-beta.1", | ||
"description": "A generated SDK for StorageClient.", | ||
"engines": { | ||
"node": ">=18.0.0" | ||
}, | ||
"sideEffects": false, | ||
"autoPublish": false, | ||
"tshy": { | ||
"exports": { | ||
"./package.json": "./package.json", | ||
".": "./src/index.ts", | ||
"./models": "./src/models/index.ts" | ||
}, | ||
"dialects": ["esm", "commonjs"], | ||
"esmDialects": ["browser", "react-native"], | ||
"selfLink": false | ||
}, | ||
"type": "module", | ||
"keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"], | ||
"author": "Microsoft Corporation", | ||
"license": "MIT", | ||
"files": ["dist", "README.md", "LICENSE", "review/*", "CHANGELOG.md"], | ||
"sdk-type": "mgmt", | ||
"repository": "github:Azure/azure-sdk-for-js", | ||
"bugs": { | ||
"url": "https://github.com/Azure/azure-sdk-for-js/issues" | ||
}, | ||
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/qumulo/arm-qumulo/README.md", | ||
"prettier": "@azure/eslint-plugin-azure-sdk/prettier.json", | ||
"//metadata": { | ||
"constantPaths": [ | ||
{ | ||
"path": "src/api/storageContext.ts", | ||
"prefix": "userAgentInfo" | ||
} | ||
] | ||
}, | ||
"dependencies": { | ||
"@azure/core-util": "^1.9.2", | ||
"@azure-rest/core-client": "^2.3.1", | ||
"@azure/core-auth": "^1.6.0", | ||
"@azure/core-rest-pipeline": "^1.5.0", | ||
"@azure/logger": "^1.0.0", | ||
"tslib": "^2.6.2", | ||
"@azure/core-lro": "^3.1.0", | ||
"@azure/abort-controller": "^2.1.2" | ||
}, | ||
"devDependencies": { | ||
"dotenv": "^16.0.0", | ||
"@microsoft/api-extractor": "^7.40.3", | ||
"@types/node": "^18.0.0", | ||
"eslint": "^9.9.0", | ||
"typescript": "~5.6.2", | ||
"@azure/identity": "^4.2.1", | ||
"@vitest/browser": "^2.0.5", | ||
"@vitest/coverage-istanbul": "^2.0.5", | ||
"playwright": "^1.41.2", | ||
"vitest": "^2.0.5", | ||
"@azure-tools/test-credential": "^2.0.0", | ||
"@azure-tools/test-recorder": "^4.0.0", | ||
"@azure/dev-tool": "^1.0.0", | ||
"@azure/eslint-plugin-azure-sdk": "^3.0.0" | ||
}, | ||
"scripts": { | ||
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log", | ||
"extract-api": "dev-tool run vendored rimraf review && dev-tool run vendored mkdirp ./review && dev-tool run extract-api", | ||
"pack": "npm pack 2>&1", | ||
"lint": "eslint package.json api-extractor.json src test", | ||
"lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]", | ||
"unit-test": "npm run unit-test:node && npm run unit-test:browser", | ||
"unit-test:browser": "npm run build:test && dev-tool run test:vitest --browser", | ||
"unit-test:node": "dev-tool run test:vitest", | ||
"integration-test": "npm run integration-test:node && npm run integration-test:browser", | ||
"integration-test:browser": "echo skipped", | ||
"integration-test:node": "echo skipped", | ||
"build:samples": "echo skipped", | ||
"check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ", | ||
"execute:samples": "echo skipped", | ||
"format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ", | ||
"generate:client": "echo skipped", | ||
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser", | ||
"minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js", | ||
"build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test", | ||
"build": "npm run clean && dev-tool run build-package && dev-tool run vendored mkdirp ./review && dev-tool run extract-api", | ||
"test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node", | ||
"test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test", | ||
"update-snippets": "echo skipped" | ||
} | ||
} |
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 @@ | ||
# Feel free to add your own environment variables. |
Oops, something went wrong.