# Microsoft Azure SDK for Python
This is the Microsoft Azure Red Hat Openshift 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-redhatopenshift
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.redhatopenshift import AzureRedHatOpenShiftClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = AzureRedHatOpenShiftClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```
## Examples
Code samples for this package can be found at:
- [Search Red Hat Openshift 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
## 2.0.0 (2024-10-30)
### Breaking Changes
- This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ingore this change.
## 1.5.0 (2024-07-22)
### Features Added
- Model NetworkProfile has a new parameter load_balancer_profile
## 1.4.0 (2023-10-23)
### Features Added
- Model NetworkProfile has a new parameter preconfigured_nsg
- Model OpenShiftCluster has a new parameter worker_profiles_status
- Model OpenShiftClusterUpdate has a new parameter worker_profiles_status
## 1.3.0 (2023-08-18)
### Features Added
- Model NetworkProfile has a new parameter outbound_type
## 1.3.0b1 (2023-02-16)
### Other Changes
- Added generated samples in github repo
- Drop support for python<3.7.0
## 1.2.0 (2023-01-17)
### Features Added
- Added operation group MachinePoolsOperations
- Added operation group OpenShiftVersionsOperations
- Added operation group SecretsOperations
- Added operation group SyncIdentityProvidersOperations
- Added operation group SyncSetsOperations
- Model Resource has a new parameter system_data
- Model TrackedResource has a new parameter system_data
## 1.1.0 (2022-05-10)
**Features**
- Added operation OpenShiftClustersOperations.list_admin_credentials
- Model ClusterProfile has a new parameter fips_validated_modules
- Model MasterProfile has a new parameter disk_encryption_set_id
- Model MasterProfile has a new parameter encryption_at_host
- Model OpenShiftCluster has a new parameter system_data
- Model OpenShiftClusterUpdate has a new parameter system_data
- Model WorkerProfile has a new parameter disk_encryption_set_id
- Model WorkerProfile has a new parameter encryption_at_host
## 1.0.0 (2021-05-20)
- GA release
## 1.0.0b1 (2020-12-10)
This is beta preview version.
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
**General breaking changes**
- Credential system has been completly revamped:
- `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
- `credentials` parameter has been renamed `credential`
- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:
- `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
- For a complete set of
supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
**General new features**
- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.
## 0.1.0 (2020-03-28)
* Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-redhatopenshift",
"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/d9/ee/8cf9dd46b9d136c5a2886514ff565c3ae9ae477cc4607353f95c38150aba/azure_mgmt_redhatopenshift-2.0.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Red Hat Openshift 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-redhatopenshift\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.redhatopenshift import AzureRedHatOpenShiftClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = AzureRedHatOpenShiftClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Red Hat Openshift 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## 2.0.0 (2024-10-30)\n\n### Breaking Changes\n\n - This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ingore this change.\n \n## 1.5.0 (2024-07-22)\n\n### Features Added\n\n - Model NetworkProfile has a new parameter load_balancer_profile\n\n## 1.4.0 (2023-10-23)\n\n### Features Added\n\n - Model NetworkProfile has a new parameter preconfigured_nsg\n - Model OpenShiftCluster has a new parameter worker_profiles_status\n - Model OpenShiftClusterUpdate has a new parameter worker_profiles_status\n\n## 1.3.0 (2023-08-18)\n\n### Features Added\n\n - Model NetworkProfile has a new parameter outbound_type\n\n## 1.3.0b1 (2023-02-16)\n\n### Other Changes\n\n - Added generated samples in github repo\n - Drop support for python<3.7.0\n\n## 1.2.0 (2023-01-17)\n\n### Features Added\n\n - Added operation group MachinePoolsOperations\n - Added operation group OpenShiftVersionsOperations\n - Added operation group SecretsOperations\n - Added operation group SyncIdentityProvidersOperations\n - Added operation group SyncSetsOperations\n - Model Resource has a new parameter system_data\n - Model TrackedResource has a new parameter system_data\n\n## 1.1.0 (2022-05-10)\n\n**Features**\n\n - Added operation OpenShiftClustersOperations.list_admin_credentials\n - Model ClusterProfile has a new parameter fips_validated_modules\n - Model MasterProfile has a new parameter disk_encryption_set_id\n - Model MasterProfile has a new parameter encryption_at_host\n - Model OpenShiftCluster has a new parameter system_data\n - Model OpenShiftClusterUpdate has a new parameter system_data\n - Model WorkerProfile has a new parameter disk_encryption_set_id\n - Model WorkerProfile has a new parameter encryption_at_host\n\n## 1.0.0 (2021-05-20)\n\n- GA release\n\n## 1.0.0b1 (2020-12-10)\n\nThis is beta preview version.\n\nThis version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).\n\n**General breaking changes**\n\n- Credential system has been completly revamped:\n\n - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/\n - `credentials` parameter has been renamed `credential`\n\n- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of\n supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n- You can't import a `version` module anymore, use `__version__` instead\n- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.\n- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).\n- Most of the operation kwarg have changed. Some of the most noticeable:\n\n - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user\n - For a complete set of\n supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n\n**General new features**\n\n- Type annotations support using `typing`. SDKs are mypy ready.\n- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.\n- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.\n\n## 0.1.0 (2020-03-28)\n\n* Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Red Hat Openshift Management Client Library for Python",
"version": "2.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": "ba484dc24fab26ddb073f01cafff6fc728e8e42d9eeb5c66ec28764817ee7d76",
"md5": "c01f6de9052b3488f6b1e67c49a8f5a7",
"sha256": "c18c47253f18c7751a941ee939e645f9739786a0117e27fbe408012b980f7f44"
},
"downloads": -1,
"filename": "azure_mgmt_redhatopenshift-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c01f6de9052b3488f6b1e67c49a8f5a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 90096,
"upload_time": "2024-10-30T07:08:57",
"upload_time_iso_8601": "2024-10-30T07:08:57.133819Z",
"url": "https://files.pythonhosted.org/packages/ba/48/4dc24fab26ddb073f01cafff6fc728e8e42d9eeb5c66ec28764817ee7d76/azure_mgmt_redhatopenshift-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d9ee8cf9dd46b9d136c5a2886514ff565c3ae9ae477cc4607353f95c38150aba",
"md5": "b8b211c43243c2e156fe3d52652cae4d",
"sha256": "9d304acbba7c9f42561269f707210aada9c7b5ea0990f2722df60599a08e3aae"
},
"downloads": -1,
"filename": "azure_mgmt_redhatopenshift-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b8b211c43243c2e156fe3d52652cae4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 65787,
"upload_time": "2024-10-30T07:08:55",
"upload_time_iso_8601": "2024-10-30T07:08:55.516265Z",
"url": "https://files.pythonhosted.org/packages/d9/ee/8cf9dd46b9d136c5a2886514ff565c3ae9ae477cc4607353f95c38150aba/azure_mgmt_redhatopenshift-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 07:08:55",
"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-redhatopenshift"
}
JSON
