# Microsoft Azure SDK for Python
This is the Microsoft Azure Mongocluster Management Client Library.
This package has been tested with Python 3.8+.
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.8+ 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 configure of 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.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
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-mongocluster",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "azure, azure sdk",
"author": "Microsoft Corporation",
"author_email": "azpysdkhelp@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/33/f1/1a5270194691da404c4bbbb945dada4a561dd6de6aa6fe68d40d13cbbdf5/azure_mgmt_mongocluster-1.0.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Mongocluster Management Client Library.\nThis package has been tested with Python 3.8+.\nFor a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).\n\n## _Disclaimer_\n\n_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_\n\n## Getting started\n\n### Prerequisites\n\n- Python 3.8+ is required to use this package.\n- [Azure subscription](https://azure.microsoft.com/free/)\n\n### Install the package\n\n```bash\npip install azure-mgmt-mongocluster\npip install azure-identity\n```\n\n### Authentication\n\nBy default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.\n\n- `AZURE_CLIENT_ID` for Azure client ID.\n- `AZURE_TENANT_ID` for Azure tenant ID.\n- `AZURE_CLIENT_SECRET` for Azure client secret.\n\nIn addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.\n\nWith above configuration, client can be authenticated by following code:\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom azure.mgmt.mongocluster import MongoClusterMgmtClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = MongoClusterMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [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\n- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)\n\n\n## Troubleshooting\n\n## Next steps\n\n## Provide Feedback\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n[Issues](https://github.com/Azure/azure-sdk-for-python/issues)\nsection of the project. \n\n\n# Release History\n\n## 1.0.0 (2024-09-26)\n\n### Features Added\n\n - Model `ConnectionString` added property `name`\n - Model `MongoClusterProperties` added property `administrator`\n - Model `MongoClusterProperties` added property `high_availability`\n - Model `MongoClusterProperties` added property `storage`\n - Model `MongoClusterProperties` added property `sharding`\n - Model `MongoClusterProperties` added property `compute`\n - Model `MongoClusterProperties` added property `backup`\n - Model `MongoClusterUpdateProperties` added property `administrator`\n - Model `MongoClusterUpdateProperties` added property `high_availability`\n - Model `MongoClusterUpdateProperties` added property `storage`\n - Model `MongoClusterUpdateProperties` added property `sharding`\n - Model `MongoClusterUpdateProperties` added property `compute`\n - Model `MongoClusterUpdateProperties` added property `backup`\n - Added model `AdministratorProperties`\n - Added model `BackupProperties`\n - Added model `ComputeProperties`\n - Added enum `HighAvailabilityMode`\n - Added model `HighAvailabilityProperties`\n - Added model `ShardingProperties`\n - Added model `StorageProperties`\n\n### Breaking Changes\n\n - Model `MongoClusterProperties` deleted or renamed its instance variable `administrator_login`\n - Model `MongoClusterProperties` deleted or renamed its instance variable `administrator_login_password`\n - Model `MongoClusterProperties` deleted or renamed its instance variable `earliest_restore_time`\n - Model `MongoClusterProperties` deleted or renamed its instance variable `node_group_specs`\n - Model `MongoClusterUpdateProperties` deleted or renamed its instance variable `administrator_login`\n - Model `MongoClusterUpdateProperties` deleted or renamed its instance variable `administrator_login_password`\n - Model `MongoClusterUpdateProperties` deleted or renamed its instance variable `node_group_specs`\n - Deleted or renamed model `NodeGroupSpec`\n - Deleted or renamed model `NodeKind`\n\n## 1.0.0b2 (2024-09-23)\n\n### Features Added\n\n - Client `MongoClusterMgmtClient` added operation group `replicas`\n - Enum `CreateMode` added member `GEO_REPLICA`\n - Enum `CreateMode` added member `REPLICA`\n - Model `MongoClusterProperties` added property `replica_parameters`\n - Model `MongoClusterProperties` added property `preview_features`\n - Model `MongoClusterProperties` added property `replica`\n - Model `MongoClusterProperties` added property `infrastructure_version`\n - Model `MongoClusterUpdateProperties` added property `preview_features`\n - Added model `MongoClusterReplicaParameters`\n - Added enum `PreviewFeature`\n - Added enum `PromoteMode`\n - Added enum `PromoteOption`\n - Added model `PromoteReplicaRequest`\n - Added model `Replica`\n - Added model `ReplicationProperties`\n - Added enum `ReplicationRole`\n - Added enum `ReplicationState`\n - Model `MongoClustersOperations` added method `begin_promote`\n - Added model `ReplicasOperations`\n\n### Breaking Changes\n\n - Model `MongoClusterRestoreParameters` renamed its instance variable `point_in_time_u_t_c` to `point_in_time_utc`\n - Model `NodeGroupSpec` renamed its instance variable `disk_size_g_b` to `disk_size_gb`\n\n## 1.0.0b1 (2024-07-01)\n\n### Other Changes\n\n - Initial version\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Mongocluster Management Client Library for Python",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2faccea61e38eb8f1347c093d5307b29468e29a021354c9cb393a7d26274170d",
"md5": "5951dd12136019f5caab6882f6059576",
"sha256": "55d018e0cbe1fae23ba53c604b74014eafbbe41aaf619295de58dc80e1e1c029"
},
"downloads": -1,
"filename": "azure_mgmt_mongocluster-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5951dd12136019f5caab6882f6059576",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 74686,
"upload_time": "2024-09-27T08:27:27",
"upload_time_iso_8601": "2024-09-27T08:27:27.732447Z",
"url": "https://files.pythonhosted.org/packages/2f/ac/cea61e38eb8f1347c093d5307b29468e29a021354c9cb393a7d26274170d/azure_mgmt_mongocluster-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "33f11a5270194691da404c4bbbb945dada4a561dd6de6aa6fe68d40d13cbbdf5",
"md5": "88894b0f8c2122c6294f8a09385259c4",
"sha256": "f397dd5398fd0682b55a1a3464fa5dbc936dc15ccc20ecf0a2b8ecce8e2b176d"
},
"downloads": -1,
"filename": "azure_mgmt_mongocluster-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "88894b0f8c2122c6294f8a09385259c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 69082,
"upload_time": "2024-09-27T08:27:26",
"upload_time_iso_8601": "2024-09-27T08:27:26.733493Z",
"url": "https://files.pythonhosted.org/packages/33/f1/1a5270194691da404c4bbbb945dada4a561dd6de6aa6fe68d40d13cbbdf5/azure_mgmt_mongocluster-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 08:27:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-mgmt-mongocluster"
}
JSON
