azure-mgmt-mongocluster 1.1.0
Microsoft Azure Mongocluster Management Client Library for Python
Requires Python: >=3.9
Keywords: azure, azure sdk

# Microsoft Azure SDK for Python

This is the Microsoft Azure Mongocluster Management Client Library.
This package has been tested with Python 3.9+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

## Getting started

### Prerequisites

- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-mongocluster
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.mongocluster import MongoClusterMgmtClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = MongoClusterMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search Mongocluster Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 

# Release History

## 1.1.0 (2025-10-15)

### Features Added

  - Model `MongoClusterMgmtClient` added parameter `cloud_setting` in method `__init__`
  - Client `MongoClusterMgmtClient` added operation group `users`
  - Model `MongoCluster` added property `identity`
  - Model `MongoClusterProperties` added property `data_api`
  - Model `MongoClusterProperties` added property `auth_config`
  - Model `MongoClusterProperties` added property `encryption`
  - Model `MongoClusterUpdate` added property `identity`
  - Model `MongoClusterUpdateProperties` added property `data_api`
  - Model `MongoClusterUpdateProperties` added property `auth_config`
  - Model `MongoClusterUpdateProperties` added property `encryption`
  - Model `StorageProperties` added property `type`
  - Added model `AuthConfigProperties`
  - Added enum `AuthenticationMode`
  - Added model `CustomerManagedKeyEncryptionProperties`
  - Added enum `DataApiMode`
  - Added model `DataApiProperties`
  - Added model `DatabaseRole`
  - Added model `EncryptionProperties`
  - Added model `EntraIdentityProvider`
  - Added model `EntraIdentityProviderProperties`
  - Added enum `EntraPrincipalType`
  - Added model `IdentityProvider`
  - Added enum `IdentityProviderType`
  - Added model `KeyEncryptionKeyIdentity`
  - Added enum `KeyEncryptionKeyIdentityType`
  - Added model `ManagedServiceIdentity`
  - Added enum `ManagedServiceIdentityType`
  - Added enum `StorageType`
  - Added model `User`
  - Added model `UserAssignedIdentity`
  - Added model `UserProperties`
  - Added enum `UserRole`
  - Added operation group `UsersOperations`

## 1.1.0b3 (2025-10-09)

### Bugs Fixed

- Exclude `generated_samples` and `generated_tests` from wheel

## 1.1.0b2 (2025-09-29)

### Features Added

  - Model `MongoClusterMgmtClient` added parameter `cloud_setting` in method `__init__`
  - Model `MongoClusterUpdateProperties` added property `encryption`

### Breaking Changes

  - Model `StorageProperties` deleted or renamed its instance variable `iops`
  - Model `StorageProperties` deleted or renamed its instance variable `throughput`

## 1.1.0b1 (2025-07-23)

### Features Added

  - Client `MongoClusterMgmtClient` added operation group `users`
  - Model `MongoCluster` added property `identity`
  - Model `MongoClusterProperties` added property `data_api`
  - Model `MongoClusterProperties` added property `auth_config`
  - Model `MongoClusterProperties` added property `encryption`
  - Model `MongoClusterUpdate` added property `identity`
  - Model `MongoClusterUpdateProperties` added property `data_api`
  - Model `MongoClusterUpdateProperties` added property `auth_config`
  - Model `StorageProperties` added property `type`
  - Model `StorageProperties` added property `iops`
  - Model `StorageProperties` added property `throughput`
  - Added model `AuthConfigProperties`
  - Added enum `AuthenticationMode`
  - Added model `CustomerManagedKeyEncryptionProperties`
  - Added enum `DataApiMode`
  - Added model `DataApiProperties`
  - Added model `DatabaseRole`
  - Added model `EncryptionProperties`
  - Added model `EntraIdentityProvider`
  - Added model `EntraIdentityProviderProperties`
  - Added enum `EntraPrincipalType`
  - Added model `IdentityProvider`
  - Added enum `IdentityProviderType`
  - Added model `KeyEncryptionKeyIdentity`
  - Added enum `KeyEncryptionKeyIdentityType`
  - Added model `ManagedServiceIdentity`
  - Added enum `ManagedServiceIdentityType`
  - Added enum `StorageType`
  - Added model `User`
  - Added model `UserAssignedIdentity`
  - Added model `UserProperties`
  - Added enum `UserRole`
  - Added model `UsersOperations`

## 1.0.0 (2024-09-26)

### Features Added

  - Model `ConnectionString` added property `name`
  - Model `MongoClusterProperties` added property `administrator`
  - Model `MongoClusterProperties` added property `high_availability`
  - Model `MongoClusterProperties` added property `storage`
  - Model `MongoClusterProperties` added property `sharding`
  - Model `MongoClusterProperties` added property `compute`
  - Model `MongoClusterProperties` added property `backup`
  - Model `MongoClusterUpdateProperties` added property `administrator`
  - Model `MongoClusterUpdateProperties` added property `high_availability`
  - Model `MongoClusterUpdateProperties` added property `storage`
  - Model `MongoClusterUpdateProperties` added property `sharding`
  - Model `MongoClusterUpdateProperties` added property `compute`
  - Model `MongoClusterUpdateProperties` added property `backup`
  - Added model `AdministratorProperties`
  - Added model `BackupProperties`
  - Added model `ComputeProperties`
  - Added enum `HighAvailabilityMode`
  - Added model `HighAvailabilityProperties`
  - Added model `ShardingProperties`
  - Added model `StorageProperties`

### Breaking Changes

  - Model `MongoClusterProperties` deleted or renamed its instance variable `administrator_login`
  - Model `MongoClusterProperties` deleted or renamed its instance variable `administrator_login_password`
  - Model `MongoClusterProperties` deleted or renamed its instance variable `earliest_restore_time`
  - Model `MongoClusterProperties` deleted or renamed its instance variable `node_group_specs`
  - Model `MongoClusterUpdateProperties` deleted or renamed its instance variable `administrator_login`
  - Model `MongoClusterUpdateProperties` deleted or renamed its instance variable `administrator_login_password`
  - Model `MongoClusterUpdateProperties` deleted or renamed its instance variable `node_group_specs`
  - Deleted or renamed model `NodeGroupSpec`
  - Deleted or renamed model `NodeKind`

## 1.0.0b2 (2024-09-23)

### Features Added

  - Client `MongoClusterMgmtClient` added operation group `replicas`
  - Enum `CreateMode` added member `GEO_REPLICA`
  - Enum `CreateMode` added member `REPLICA`
  - Model `MongoClusterProperties` added property `replica_parameters`
  - Model `MongoClusterProperties` added property `preview_features`
  - Model `MongoClusterProperties` added property `replica`
  - Model `MongoClusterProperties` added property `infrastructure_version`
  - Model `MongoClusterUpdateProperties` added property `preview_features`
  - Added model `MongoClusterReplicaParameters`
  - Added enum `PreviewFeature`
  - Added enum `PromoteMode`
  - Added enum `PromoteOption`
  - Added model `PromoteReplicaRequest`
  - Added model `Replica`
  - Added model `ReplicationProperties`
  - Added enum `ReplicationRole`
  - Added enum `ReplicationState`
  - Model `MongoClustersOperations` added method `begin_promote`
  - Added model `ReplicasOperations`

### Breaking Changes

  - Model `MongoClusterRestoreParameters` renamed its instance variable `point_in_time_u_t_c` to `point_in_time_utc`
  - Model `NodeGroupSpec` renamed its instance variable `disk_size_g_b` to `disk_size_gb`

## 1.0.0b1 (2024-07-01)

### Other Changes

  - Initial version