-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[mgmt] Mongocluster with modular #30102
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
Merged
Merged
Changes from 10 commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
f750d1d
[mgmt] mongocluster release
kazrael2119 7cc1e0c
update
kazrael2119 e882bc2
merge main
kazrael2119 662b1ba
[mgmt] mongocluster with modular
kazrael2119 f440368
update
kazrael2119 4f76ab5
update
kazrael2119 90af18e
update
kazrael2119 4348ca2
update
kazrael2119 e2a42b0
merge main
kazrael2119 7954cc1
regen with script
kazrael2119 deaecda
Update README.md
kazrael2119 db3b91a
ypdate
kazrael2119 d2617c7
add timeout
kazrael2119 13df5ae
update code with experimentalExtensibleEnums: true
kazrael2119 a22e763
Add LICENSE manually
kazrael2119 0101462
update
kazrael2119 ae14874
update ClientOptions to ClientOptionalParams manually
kazrael2119 7c8eb82
Update mongocluster_operations_test.spec.ts
kazrael2119 8949f90
Update README.md
kazrael2119 4cba7b3
merge main
kazrael2119 c990758
update
kazrael2119 06a0b63
update test case
kazrael2119 19dac60
update
kazrael2119 b6bf2d8
Update the cases for node only
MaryGao 2d699e0
update
kazrael2119 fcb38b7
merge main
kazrael2119 12b3c89
resolve comments
qiaozha File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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 hidden or 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 hidden or 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,14 @@ | ||
| { | ||
| "plugins": ["@azure/azure-sdk"], | ||
| "extends": ["plugin:@azure/azure-sdk/azure-sdk-base"], | ||
| "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", | ||
| "tsdoc/syntax": "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" | ||
| } | ||
| } |
This file contains hidden or 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,57 @@ | ||
| # Azure MongoClusterManagement REST client library for JavaScript | ||
|
|
||
| The Microsoft Azure management API provides create, read, update, and delete functionality for Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules. | ||
|
|
||
| **If you are not familiar with our REST client, please spend 5 minutes to take a look at our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library, the REST client provides a light-weighted & developer friendly way to call azure rest api | ||
|
|
||
| Key links: | ||
|
|
||
| - [Package (NPM)](https://www.npmjs.com/package/@azure/arm-mongocluster) | ||
| - [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-mongocluster?view=azure-node-preview) | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Currently supported environments | ||
|
|
||
| - LTS versions of Node.js | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package. | ||
|
|
||
| ### Install the `@azure/arm-mongocluster` package | ||
|
|
||
| Install the Azure MongoClusterManagement REST client REST client library for JavaScript with `npm`: | ||
|
|
||
| ```bash | ||
| npm install @azure/arm-mongocluster | ||
| ``` | ||
|
|
||
| ### Create and authenticate a `DocumentDBClient` | ||
|
|
||
| To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token), | ||
| provide an instance of the desired credential type obtained from the | ||
| [@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library. | ||
|
|
||
| To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) | ||
|
|
||
| After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use. | ||
| As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential) | ||
| can be used to authenticate the client. | ||
|
|
||
| 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 | ||
|
|
||
| ## 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). | ||
This file contains hidden or 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-mongocluster.d.ts" | ||
| }, | ||
| "messages": { | ||
| "tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
| "extractorMessageReporting": { | ||
| "ae-missing-release-tag": { "logLevel": "none" }, | ||
| "ae-unresolved-link": { "logLevel": "none" } | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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,133 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| // https://github.com/karma-runner/karma-chrome-launcher | ||
| process.env.CHROME_BIN = require("puppeteer").executablePath(); | ||
| require("dotenv").config(); | ||
| const { relativeRecordingsPath } = require("@azure-tools/test-recorder"); | ||
| process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath(); | ||
|
|
||
| module.exports = function (config) { | ||
| config.set({ | ||
| // base path that will be used to resolve all patterns (eg. files, exclude) | ||
| basePath: "./", | ||
|
|
||
| // frameworks to use | ||
| // available frameworks: https://npmjs.org/browse/keyword/karma-adapter | ||
| frameworks: ["source-map-support", "mocha"], | ||
|
|
||
| plugins: [ | ||
| "karma-mocha", | ||
| "karma-mocha-reporter", | ||
| "karma-chrome-launcher", | ||
| "karma-firefox-launcher", | ||
| "karma-env-preprocessor", | ||
| "karma-coverage", | ||
| "karma-sourcemap-loader", | ||
| "karma-junit-reporter", | ||
| "karma-source-map-support", | ||
| ], | ||
|
|
||
| // list of files / patterns to load in the browser | ||
| files: [ | ||
| "dist-test/index.browser.js", | ||
| { | ||
| pattern: "dist-test/index.browser.js.map", | ||
| type: "html", | ||
| included: false, | ||
| served: true, | ||
| }, | ||
| ], | ||
|
|
||
| // list of files / patterns to exclude | ||
| exclude: [], | ||
|
|
||
| // preprocess matching files before serving them to the browser | ||
| // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor | ||
| preprocessors: { | ||
| "**/*.js": ["sourcemap", "env"], | ||
| // IMPORTANT: COMMENT following line if you want to debug in your browsers!! | ||
| // Preprocess source file to calculate code coverage, however this will make source file unreadable | ||
| // "dist-test/index.js": ["coverage"] | ||
| }, | ||
|
|
||
| envPreprocessor: [ | ||
| "TEST_MODE", | ||
| "ENDPOINT", | ||
| "AZURE_CLIENT_SECRET", | ||
| "AZURE_CLIENT_ID", | ||
| "AZURE_TENANT_ID", | ||
| "SUBSCRIPTION_ID", | ||
| "RECORDINGS_RELATIVE_PATH", | ||
| ], | ||
|
|
||
| // test results reporter to use | ||
| // possible values: 'dots', 'progress' | ||
| // available reporters: https://npmjs.org/browse/keyword/karma-reporter | ||
| reporters: ["mocha", "coverage", "junit"], | ||
|
|
||
| coverageReporter: { | ||
| // specify a common output directory | ||
| dir: "coverage-browser/", | ||
| reporters: [ | ||
| { type: "json", subdir: ".", file: "coverage.json" }, | ||
| { type: "lcovonly", subdir: ".", file: "lcov.info" }, | ||
| { type: "html", subdir: "html" }, | ||
| { type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" }, | ||
| ], | ||
| }, | ||
|
|
||
| junitReporter: { | ||
| outputDir: "", // results will be saved as $outputDir/$browserName.xml | ||
| outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile | ||
| suite: "", // suite will become the package name attribute in xml testsuite element | ||
| useBrowserName: false, // add browser name to report and classes names | ||
| nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element | ||
| classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element | ||
| properties: {}, // key value pair of properties to add to the <properties> section of the report | ||
| }, | ||
|
|
||
| // web server port | ||
| port: 9876, | ||
|
|
||
| // enable / disable colors in the output (reporters and logs) | ||
| colors: true, | ||
|
|
||
| // level of logging | ||
| // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG | ||
| logLevel: config.LOG_INFO, | ||
|
|
||
| // enable / disable watching file and executing tests whenever any file changes | ||
| autoWatch: false, | ||
|
|
||
| // --no-sandbox allows our tests to run in Linux without having to change the system. | ||
| // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex. | ||
| browsers: ["ChromeHeadlessNoSandbox"], | ||
| customLaunchers: { | ||
| ChromeHeadlessNoSandbox: { | ||
| base: "ChromeHeadless", | ||
| flags: ["--no-sandbox", "--disable-web-security"], | ||
| }, | ||
| }, | ||
|
|
||
| // Continuous Integration mode | ||
| // if true, Karma captures browsers, runs the tests and exits | ||
| singleRun: false, | ||
|
|
||
| // Concurrency level | ||
| // how many browser should be started simultaneous | ||
| concurrency: 1, | ||
|
|
||
| browserNoActivityTimeout: 60000000, | ||
| browserDisconnectTimeout: 10000, | ||
| browserDisconnectTolerance: 3, | ||
|
|
||
| client: { | ||
| mocha: { | ||
| // change Karma's debug.html to the mocha web reporter | ||
| reporter: "html", | ||
| timeout: "600000", | ||
| }, | ||
| }, | ||
| }); | ||
| }; |
This file contains hidden or 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,96 @@ | ||
| { | ||
| "name": "@azure/arm-mongocluster", | ||
| "version": "1.0.0-beta.1", | ||
| "description": "DocumentDB MongoCluster Service", | ||
| "engines": { | ||
| "node": ">=18.0.0" | ||
| }, | ||
| "sideEffects": false, | ||
| "autoPublish": false, | ||
| "tshy": { | ||
| "exports": { | ||
| "./package.json": "./package.json", | ||
| ".": "./src/index.ts", | ||
| "./api": "./src/api/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/*"], | ||
| "sdk-type": "client", | ||
| "repository": "github:Azure/azure-sdk-for-js", | ||
| "bugs": { | ||
| "url": "https://github.com/Azure/azure-sdk-for-js/issues" | ||
| }, | ||
| "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json", | ||
| "//metadata": { | ||
| "constantPaths": [ | ||
| { | ||
| "path": "src/rest/documentDBClient.ts", | ||
| "prefix": "package-version" | ||
| } | ||
| ] | ||
| }, | ||
| "dependencies": { | ||
| "@azure-rest/core-client": "^2.1.0", | ||
| "@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.0.0", | ||
| "@azure/abort-controller": "^2.1.2", | ||
| "@azure/core-paging": "^1.5.0" | ||
| }, | ||
| "devDependencies": { | ||
| "dotenv": "^16.0.0", | ||
| "@microsoft/api-extractor": "^7.40.3", | ||
| "@types/node": "^18.0.0", | ||
| "eslint": "^8.55.0", | ||
| "prettier": "^3.2.5", | ||
| "rimraf": "^5.0.5", | ||
| "mkdirp": "^3.0.1", | ||
| "typescript": "~5.4.5", | ||
| "tshy": "^1.11.1", | ||
| "@azure/core-util": "^1.0.0", | ||
| "@azure/identity": "^4.2.1", | ||
| "@vitest/browser": "^1.3.1", | ||
| "@vitest/coverage-istanbul": "^1.3.1", | ||
| "playwright": "^1.41.2", | ||
| "vitest": "^1.3.1", | ||
| "@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": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log", | ||
| "extract-api": "rimraf review && mkdirp ./review && dev-tool run extract-api", | ||
| "pack": "npm pack 2>&1", | ||
| "lint": "eslint package.json api-extractor.json src test --ext .ts --ext .cts --ext .mts", | ||
| "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --ext .cts --ext .mts --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", | ||
| "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit", | ||
| "build:samples": "dev-tool samples publish --force", | ||
kazrael2119 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "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": "dev-tool samples run samples-dev", | ||
| "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": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js", | ||
| "build:test": "npm run clean && tshy && dev-tool run build-test", | ||
| "build": "npm run clean && tshy && mkdirp ./review && dev-tool run extract-api", | ||
| "test:node": "npm run clean && tshy && npm run unit-test:node && npm run integration-test:node", | ||
| "test": "npm run clean && tshy && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test" | ||
| } | ||
| } | ||
24 changes: 24 additions & 0 deletions
24
sdk/mongocluster/arm-mongocluster/src/api/documentDBContext.ts
This file contains hidden or 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,24 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| import { TokenCredential } from "@azure/core-auth"; | ||
| import { ClientOptions } from "@azure-rest/core-client"; | ||
| import { DocumentDBContext } from "../rest/index.js"; | ||
| import getClient from "../rest/index.js"; | ||
|
|
||
| /** Optional parameters for the client. */ | ||
| export interface DocumentDBClientOptions extends ClientOptions { | ||
| /** The API version to use for this operation. */ | ||
| apiVersion?: string; | ||
| } | ||
|
|
||
| export { DocumentDBContext } from "../rest/index.js"; | ||
|
|
||
| /** The Microsoft Azure management API provides create, read, update, and delete functionality for Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules. */ | ||
| export function createDocumentDB( | ||
| credential: TokenCredential, | ||
| options: DocumentDBClientOptions = {}, | ||
| ): DocumentDBContext { | ||
| const clientContext = getClient(credential, options); | ||
| return clientContext; | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.