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.
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
Install the package
pip install azure-mgmt-resourcehealth
pip install azure-identity
Authentication
By default, Azure Active Directory 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:
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:
Troubleshooting
Next steps
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
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)
