Azure Resource Manager Mongo Cluster client library for Java - version 1.0.0

Artigo
09/26/2024

Azure Resource Manager Mongo Cluster client library for Java.

This package contains Microsoft Azure SDK for Mongo Cluster Management SDK. 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. For documentation on how to use this package, please see Azure Management Libraries for Java.

We'd love to hear your feedback

We're always working on improving our products and the way we communicate with our users. So we'd love to learn what's working and how we can do better.

If you haven't already, please take a few minutes to complete this short survey we have put together.

Thank you in advance for your collaboration. We really appreciate your time!

Documentation

Various documentation is available to help you get started

API reference documentation

Getting started

Prerequisites

Java Development Kit (JDK) with version 8 or above
Azure Subscription

Adding the package to your product

<dependency>
    <groupId>com.azure.resourcemanager</groupId>
    <artifactId>azure-resourcemanager-mongocluster</artifactId>
    <version>1.0.0</version>
</dependency>

Include the recommended packages

Azure Management Libraries require a TokenCredential implementation for authentication and an HttpClient implementation for HTTP client.

Azure Identity and Azure Core Netty HTTP packages provide the default implementation.

Authentication

Microsoft Entra ID token authentication relies on the credential class from Azure Identity package.

Azure subscription ID can be configured via AZURE_SUBSCRIPTION_ID environment variable.

Assuming the use of the DefaultAzureCredential credential class, the client can be authenticated using the following code:

AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
TokenCredential credential = new DefaultAzureCredentialBuilder()
    .authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
    .build();
MongoClusterManager manager = MongoClusterManager
    .authenticate(credential, profile);

The sample code assumes global Azure. Please change AzureEnvironment.AZURE variable if otherwise.

See Authentication for more options.

Key concepts

See API design for general introduction on design and key concepts on Azure Management Libraries.

Examples

mongoCluster = mongoClusterManager.mongoClusters()
    .define(clusterName)
    .withRegion(REGION)
    .withExistingResourceGroup(resourceGroupName)
    .withProperties(
        new MongoClusterProperties()
            .withAdministratorLogin(loginUser)
            .withAdministratorLoginPassword(loginPwd)
            .withPublicNetworkAccess(PublicNetworkAccess.ENABLED)
            .withNodeGroupSpecs(Arrays.asList(
                new NodeGroupSpec()
                    .withKind(NodeKind.SHARD)
                    .withSku("M30")
                    .withDiskSizeGB(128L)
                    .withEnableHa(true)
                    .withNodeCount(1)
                ))
            .withServerVersion("7.0")
        )
    .create();

Code snippets and samples

Troubleshooting

Next steps

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Impressions

Partilhar via