-
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 26 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,15 @@ | ||
| { | ||
| "extends": "./build.json", | ||
| "include": [ | ||
| "../src/**/*.ts", | ||
| "../src/**/*.mts", | ||
| "../src/**/*.tsx", | ||
| "../src/**/*.json" | ||
| ], | ||
| "exclude": [ | ||
| "../src/package.json" | ||
| ], | ||
| "compilerOptions": { | ||
| "outDir": "../.tshy-build/browser" | ||
| } | ||
| } |
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,8 @@ | ||
| { | ||
| "extends": "../tsconfig.json", | ||
| "compilerOptions": { | ||
| "rootDir": "../src", | ||
| "module": "nodenext", | ||
| "moduleResolution": "nodenext" | ||
| } | ||
| } |
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,16 @@ | ||
| { | ||
| "extends": "./build.json", | ||
| "include": [ | ||
| "../src/**/*.ts", | ||
| "../src/**/*.cts", | ||
| "../src/**/*.tsx", | ||
| "../src/**/*.json" | ||
| ], | ||
| "exclude": [ | ||
| "../src/**/*.mts", | ||
| "../src/package.json" | ||
| ], | ||
| "compilerOptions": { | ||
| "outDir": "../.tshy-build/commonjs" | ||
| } | ||
| } |
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,15 @@ | ||
| { | ||
| "extends": "./build.json", | ||
| "include": [ | ||
| "../src/**/*.ts", | ||
| "../src/**/*.mts", | ||
| "../src/**/*.tsx", | ||
| "../src/**/*.json" | ||
| ], | ||
| "exclude": [ | ||
| "../src/package.json" | ||
| ], | ||
| "compilerOptions": { | ||
| "outDir": "../.tshy-build/esm" | ||
| } | ||
| } |
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,15 @@ | ||
| { | ||
| "extends": "./build.json", | ||
| "include": [ | ||
| "../src/**/*.ts", | ||
| "../src/**/*.mts", | ||
| "../src/**/*.tsx", | ||
| "../src/**/*.json" | ||
| ], | ||
| "exclude": [ | ||
| "../src/package.json" | ||
| ], | ||
| "compilerOptions": { | ||
| "outDir": "../.tshy-build/react-native" | ||
| } | ||
| } |
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,5 @@ | ||
| # Release History | ||
|
|
||
| ## 1.0.0-beta.1 (2024-07-02) | ||
|
|
||
| The package of @azure/arm-mongocluster is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart). | ||
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,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 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,109 @@ | ||
| # Azure MongoClusterManagement client library for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure MongoClusterManagement client. | ||
|
|
||
| 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. | ||
|
|
||
| [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/mongocluster/arm-mongocluster) | | ||
| [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) | | ||
| [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-mongocluster` package | ||
|
|
||
| Install the Azure MongoClusterManagement client library for JavaScript with `npm`: | ||
|
|
||
| ```bash | ||
| npm install @azure/arm-mongocluster | ||
| ``` | ||
|
|
||
| ### Create and authenticate a `MongoClusterManagementClient` | ||
|
|
||
| To create a client object to access the Azure MongoClusterManagement API, you will need the `endpoint` of your Azure MongoClusterManagement resource and a `credential`. The Azure MongoClusterManagement client can use Azure Active Directory credentials to authenticate. | ||
| You can find the endpoint for your Azure MongoClusterManagement 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 MongoClusterManagement** 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 { MongoClusterManagementClient } = require("@azure/arm-mongocluster"); | ||
| 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 MongoClusterManagementClient(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 MongoClusterManagementClient(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 | ||
|
|
||
| ### MongoClusterManagementClient | ||
|
|
||
| `MongoClusterManagementClient` is the primary interface for developers using the Azure MongoClusterManagement client library. Explore the methods on this client object to understand the different features of the Azure MongoClusterManagement 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) | ||
|
|
||
|  | ||
|
|
||
| [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 |
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,6 @@ | ||
| { | ||
| "AssetsRepo": "Azure/azure-sdk-assets", | ||
| "AssetsRepoPrefixPath": "js", | ||
| "TagPrefix": "js/mongocluster/arm-mongocluster", | ||
| "Tag": "js/mongocluster/arm-mongocluster_c6236b1752" | ||
| } |
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.