# Microsoft Azure SDK for Python
This is the Microsoft Azure Resource Health 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-resourcehealth
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.resourcehealth import ResourceHealthMgmtClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ResourceHealthMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```
## Examples
Code samples for this package can be found at:
- [Search Resource Health 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.0b6 (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.0.0b5 (2023-10-23)
### Features Added
- Model Event has a new parameter arg_query
- Model Event has a new parameter event_sub_type
- Model Event has a new parameter maintenance_id
- Model Event has a new parameter maintenance_type
- Model EventImpactedResource has a new parameter maintenance_end_time
- Model EventImpactedResource has a new parameter maintenance_start_time
- Model EventImpactedResource has a new parameter resource_group
- Model EventImpactedResource has a new parameter resource_name
- Model EventImpactedResource has a new parameter status
## 1.0.0b4 (2023-05-19)
### Features Added
- Added operation EventsOperations.list_by_tenant_id
- Added operation group EventOperations
- Added operation group ImpactedResourcesOperations
- Added operation group SecurityAdvisoryImpactedResourcesOperations
- Model AvailabilityStatusProperties has a new parameter article_id
- Model AvailabilityStatusProperties has a new parameter category
- Model AvailabilityStatusProperties has a new parameter context
- Model AvailabilityStatusProperties has a new parameter occured_time
- Model AvailabilityStatusProperties has a new parameter title
- Model AvailabilityStatusPropertiesRecentlyResolved has a new parameter unavailable_occured_time
- Model AvailabilityStatusPropertiesRecentlyResolved has a new parameter unavailable_summary
- Model EmergingIssuesGetResult has a new parameter system_data
- Model Event has a new parameter additional_information
- Model Event has a new parameter duration
- Model Event has a new parameter external_incident_id
- Model Event has a new parameter impact_type
- Model Event has a new parameter reason
- Model Event has a new parameter system_data
- Model EventPropertiesArticle has a new parameter article_id
- Model EventPropertiesArticle has a new parameter parameters
- Model ImpactedServiceRegion has a new parameter impacted_tenants
- Model MetadataEntity has a new parameter system_data
- Model MetadataSupportedValueDetail has a new parameter resource_types
- Model RecommendedAction has a new parameter action_url_comment
- Model Resource has a new parameter system_data
### Breaking Changes
- Client name is changed from `MicrosoftResourceHealth` to `ResourceHealthMgmtClient`
- Model AvailabilityStatusProperties no longer has parameter occurred_time
- Model AvailabilityStatusPropertiesRecentlyResolved no longer has parameter unavailability_summary
- Model AvailabilityStatusPropertiesRecentlyResolved no longer has parameter unavailable_occurred_time
- Operation EventsOperations.list_by_single_resource no longer has parameter view
- Operation EventsOperations.list_by_subscription_id no longer has parameter view
## 1.0.0b3 (2023-02-16)
### Other Changes
- Added generated samples in github repo
- Drop support for python<3.7.0
## 1.0.0b2 (2022-11-15)
### Features Added
- Added operation group EmergingIssuesOperations
- Added operation group EventsOperations
- Added operation group MetadataOperations
- Model AvailabilityStatusProperties has a new parameter health_event_category
- Model AvailabilityStatusProperties has a new parameter health_event_cause
- Model AvailabilityStatusProperties has a new parameter health_event_id
- Model AvailabilityStatusProperties has a new parameter health_event_type
- Model AvailabilityStatusProperties has a new parameter occurred_time
- Model AvailabilityStatusProperties has a new parameter recently_resolved
### Breaking Changes
- Model AvailabilityStatusProperties no longer has parameter is_arm_resource
- Model AvailabilityStatusProperties no longer has parameter occured_time
- Model AvailabilityStatusProperties no longer has parameter recently_resolved_state
## 1.0.0b1 (2021-06-25)
* Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-resourcehealth",
"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/2f/bc/512a48904416d0a142ab147f029d3b185730796bbbd4bddfc3f7649aa8b5/azure_mgmt_resourcehealth-1.0.0b6.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Resource Health 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-resourcehealth\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.resourcehealth import ResourceHealthMgmtClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = ResourceHealthMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Resource Health 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.0b6 (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.0.0b5 (2023-10-23)\n\n### Features Added\n\n - Model Event has a new parameter arg_query\n - Model Event has a new parameter event_sub_type\n - Model Event has a new parameter maintenance_id\n - Model Event has a new parameter maintenance_type\n - Model EventImpactedResource has a new parameter maintenance_end_time\n - Model EventImpactedResource has a new parameter maintenance_start_time\n - Model EventImpactedResource has a new parameter resource_group\n - Model EventImpactedResource has a new parameter resource_name\n - Model EventImpactedResource has a new parameter status\n\n## 1.0.0b4 (2023-05-19)\n\n### Features Added\n\n - Added operation EventsOperations.list_by_tenant_id\n - Added operation group EventOperations\n - Added operation group ImpactedResourcesOperations\n - Added operation group SecurityAdvisoryImpactedResourcesOperations\n - Model AvailabilityStatusProperties has a new parameter article_id\n - Model AvailabilityStatusProperties has a new parameter category\n - Model AvailabilityStatusProperties has a new parameter context\n - Model AvailabilityStatusProperties has a new parameter occured_time\n - Model AvailabilityStatusProperties has a new parameter title\n - Model AvailabilityStatusPropertiesRecentlyResolved has a new parameter unavailable_occured_time\n - Model AvailabilityStatusPropertiesRecentlyResolved has a new parameter unavailable_summary\n - Model EmergingIssuesGetResult has a new parameter system_data\n - Model Event has a new parameter additional_information\n - Model Event has a new parameter duration\n - Model Event has a new parameter external_incident_id\n - Model Event has a new parameter impact_type\n - Model Event has a new parameter reason\n - Model Event has a new parameter system_data\n - Model EventPropertiesArticle has a new parameter article_id\n - Model EventPropertiesArticle has a new parameter parameters\n - Model ImpactedServiceRegion has a new parameter impacted_tenants\n - Model MetadataEntity has a new parameter system_data\n - Model MetadataSupportedValueDetail has a new parameter resource_types\n - Model RecommendedAction has a new parameter action_url_comment\n - Model Resource has a new parameter system_data\n\n### Breaking Changes\n\n - Client name is changed from `MicrosoftResourceHealth` to `ResourceHealthMgmtClient`\n - Model AvailabilityStatusProperties no longer has parameter occurred_time\n - Model AvailabilityStatusPropertiesRecentlyResolved no longer has parameter unavailability_summary\n - Model AvailabilityStatusPropertiesRecentlyResolved no longer has parameter unavailable_occurred_time\n - Operation EventsOperations.list_by_single_resource no longer has parameter view\n - Operation EventsOperations.list_by_subscription_id no longer has parameter view\n\n## 1.0.0b3 (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.0.0b2 (2022-11-15)\n\n### Features Added\n\n - Added operation group EmergingIssuesOperations\n - Added operation group EventsOperations\n - Added operation group MetadataOperations\n - Model AvailabilityStatusProperties has a new parameter health_event_category\n - Model AvailabilityStatusProperties has a new parameter health_event_cause\n - Model AvailabilityStatusProperties has a new parameter health_event_id\n - Model AvailabilityStatusProperties has a new parameter health_event_type\n - Model AvailabilityStatusProperties has a new parameter occurred_time\n - Model AvailabilityStatusProperties has a new parameter recently_resolved\n\n### Breaking Changes\n\n - Model AvailabilityStatusProperties no longer has parameter is_arm_resource\n - Model AvailabilityStatusProperties no longer has parameter occured_time\n - Model AvailabilityStatusProperties no longer has parameter recently_resolved_state\n\n## 1.0.0b1 (2021-06-25)\n\n* Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Resource Health Management Client Library for Python",
"version": "1.0.0b6",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e49e43827e32bdb72091f71e69d7cb04483f4634a66df2cf1a56157613555b83",
"md5": "cf1f60e8429837f0a74ce43747cf42a0",
"sha256": "abc702274222e6abfdc08a4cc93142362feb3e8d7efe44d95f9fcbc20090b54f"
},
"downloads": -1,
"filename": "azure_mgmt_resourcehealth-1.0.0b6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf1f60e8429837f0a74ce43747cf42a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 103081,
"upload_time": "2024-10-30T08:26:03",
"upload_time_iso_8601": "2024-10-30T08:26:03.661606Z",
"url": "https://files.pythonhosted.org/packages/e4/9e/43827e32bdb72091f71e69d7cb04483f4634a66df2cf1a56157613555b83/azure_mgmt_resourcehealth-1.0.0b6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2fbc512a48904416d0a142ab147f029d3b185730796bbbd4bddfc3f7649aa8b5",
"md5": "6afed5de9d35a191d6bb414ce199c4d4",
"sha256": "02919de1c8f9926008ded3bf87d441c3a1cd868ae745da5431c403d353e0ae6e"
},
"downloads": -1,
"filename": "azure_mgmt_resourcehealth-1.0.0b6.tar.gz",
"has_sig": false,
"md5_digest": "6afed5de9d35a191d6bb414ce199c4d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 59793,
"upload_time": "2024-10-30T08:26:01",
"upload_time_iso_8601": "2024-10-30T08:26:01.640355Z",
"url": "https://files.pythonhosted.org/packages/2f/bc/512a48904416d0a142ab147f029d3b185730796bbbd4bddfc3f7649aa8b5/azure_mgmt_resourcehealth-1.0.0b6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 08:26:01",
"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-resourcehealth"
}
JSON
