Microsoft Azure SDK for Python

This is the Microsoft Azure Cloudhealth Management Client Library. This package has been tested with Python 3.10+. 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

• Python 3.10+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-cloudhealth
pip install azure-identity

Authentication

By default, Microsoft Entra 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:

from azure.identity import DefaultAzureCredential
from azure.mgmt.cloudhealth import CloudHealthMgmtClient
import os

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

Examples

Code samples for this package can be found at:

• Search Cloudhealth Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

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.0b5 (2026-09-25)

Features Added

• Model SignalConfiguration added property applicable_resource_types
• Model SignalConfiguration added property configuration
• Model SignalConfiguration added property data_unit
• Model SignalConfiguration added property description
• Model SignalConfiguration added property display_name
• Model SignalConfiguration added property refresh_interval
• Added model AzureResourceMetricRecommendationConfiguration
• Added model LogAnalyticsQueryRecommendationConfiguration
• Added model PrometheusMetricsRecommendationConfiguration
• Added model SignalRecommendationConfiguration
• Added enum SignalRecommendationKind

Breaking Changes

• Model SignalConfiguration deleted or renamed its instance variable aggregation_type
• Model SignalConfiguration deleted or renamed its instance variable dimension_filter
• Model SignalConfiguration deleted or renamed its instance variable metric_name
• Model SignalConfiguration deleted or renamed its instance variable metric_namespace
• Model SignalConfiguration deleted or renamed its instance variable time_grain
• Model SignalConfiguration deleted or renamed its instance variable unit

1.0.0b4 (2026-08-25)

Features Added

• Model EntityProperties added property signal_aggregation_groups
• Added model SignalAggregationGroup

Breaking Changes

• Deleted or renamed enum value HealthState.DELETED
• Model ThresholdRuleV2 deleted or renamed its instance variable look_back_window
• Renamed enum DependenciesAggregationType to AggregationType
• Renamed enum DependenciesAggregationUnit to AggregationUnit
• Deleted enum LookBackWindow

1.0.0b3 (2026-07-07)

Features Added

• Model AzureResourceSignals added property resource_health
• Model DiscoveryRuleProperties added property add_resource_health_signal
• Model EntityHistoryRequest added property top
• Model EntityHistoryRequest added property next_marker
• Model EntityHistoryResponse added property next_marker
• Enum RefreshInterval added member PT10_M
• Enum RefreshInterval added member PT15_M
• Enum RefreshInterval added member PT1_H
• Enum RefreshInterval added member PT1_M
• Enum RefreshInterval added member PT2_H
• Enum RefreshInterval added member PT30_M
• Enum RefreshInterval added member PT5_M
• Model SignalHistoryRequest added property top
• Model SignalHistoryRequest added property next_marker
• Model SignalHistoryResponse added property next_marker
• Enum SignalOperator added member DYNAMIC
• Model SignalStatus added property additional_context
• Model ThresholdRuleV2 added property sensitivity
• Model ThresholdRuleV2 added property look_back_window
• Added model AddDataAnnotationRequest
• Added model AzureResourceHealthSignal
• Added model AzureResourceHealthSignalStatus
• Added model DataAnnotation
• Added enum DynamicThresholdSensitivity
• Added model GetDataAnnotationsRequest
• Added model GetDataAnnotationsResponse
• Added model GetSignalRecommendationsResponse
• Added enum LookBackWindow
• Added enum ResourceHealthAvailabilityState
• Added enum ResourceHealthAvailabilityStateSignalBehavior
• Added enum ResourceHealthCategory
• Added enum ResourceHealthReasonChronicity
• Added enum ResourceHealthReasonType
• Added model SignalConfiguration
• Operation group EntitiesOperations added method add_data_annotation
• Operation group EntitiesOperations added method get_data_annotations
• Operation group EntitiesOperations added method get_signal_recommendations

Breaking Changes

• Deleted or renamed enum value RefreshInterval.PT10M
• Deleted or renamed enum value RefreshInterval.PT1H
• Deleted or renamed enum value RefreshInterval.PT1M
• Deleted or renamed enum value RefreshInterval.PT2H
• Deleted or renamed enum value RefreshInterval.PT30M
• Deleted or renamed enum value RefreshInterval.PT5M
• Model AzureResourceSignal deleted or renamed its instance variable dimension
• Model ResourceMetricSignalDefinitionProperties deleted or renamed its instance variable dimension

1.0.0b2 (2026-04-24)

Features Added

• Client CloudHealthMgmtClient added parameter cloud_setting in method __init__
• Enum DependenciesAggregationType added member MAX_NOT_HEALTHY
• Enum DependenciesAggregationType added member MIN_HEALTHY
• Model DiscoveryRuleProperties added property specification
• Model DiscoveryRuleProperties added property error
• Model EntityProperties added property tags
• Model EntityProperties added property signal_groups
• Enum HealthState added member UNHEALTHY
• Model LogAnalyticsQuerySignalDefinitionProperties added property tags
• Model PrometheusMetricsSignalDefinitionProperties added property tags
• Model RelationshipProperties added property tags
• Model ResourceMetricSignalDefinitionProperties added property tags
• Model SignalDefinitionProperties added property tags
• Enum SignalKind added member EXTERNAL_SIGNAL
• Enum SignalOperator added member EQUAL
• Enum SignalOperator added member GREATER_THAN_OR_EQUAL
• Enum SignalOperator added member LESS_THAN
• Enum SignalOperator added member LESS_THAN_OR_EQUAL
• Enum SignalOperator added member NOT_EQUAL
• Added model ApplicationInsightsTopologySpecification
• Added model AzureMonitorWorkspaceSignals
• Added model AzureResourceSignal
• Added model AzureResourceSignals
• Added enum DependenciesAggregationUnit
• Added model DependenciesSignalGroupV2
• Added model DiscoveryError
• Added enum DiscoveryRuleKind
• Added model DiscoveryRuleSpecification
• Added model EntityHistoryRequest
• Added model EntityHistoryResponse
• Added model ExternalSignal
• Added model ExternalSignalGroup
• Added model HealthReportEvaluationRule
• Added model HealthReportRequest
• Added model HealthStateTransition
• Added model LogAnalyticsSignal
• Added model LogAnalyticsSignals
• Added model PrometheusMetricsSignal
• Added model ResourceGraphQuerySpecification
• Added model SignalGroups
• Added model SignalHistoryDataPoint
• Added model SignalHistoryRequest
• Added model SignalHistoryResponse
• Added model SignalInstanceProperties
• Added model SignalStatus
• Added model ThresholdRuleV2
• Operation group EntitiesOperations added method get_history
• Operation group EntitiesOperations added method get_signal_history
• Operation group EntitiesOperations added method ingest_health_report

Breaking Changes

• Deleted or renamed enum value DependenciesAggregationType.THRESHOLDS
• Model DiscoveryRuleProperties deleted or renamed its instance variable resource_graph_query
• Model DiscoveryRuleProperties deleted or renamed its instance variable deletion_date
• Model DiscoveryRuleProperties deleted or renamed its instance variable error_message
• Model DiscoveryRuleProperties deleted or renamed its instance variable number_of_discovered_entities
• Model EntityProperties deleted or renamed its instance variable kind
• Model EntityProperties deleted or renamed its instance variable labels
• Model EntityProperties deleted or renamed its instance variable signals
• Model EntityProperties deleted or renamed its instance variable deletion_date
• Model EvaluationRule deleted or renamed its instance variable dynamic_detection_rule
• Model HealthModelProperties deleted or renamed its instance variable dataplane_endpoint
• Model HealthModelProperties deleted or renamed its instance variable discovery
• Model HealthModelUpdate deleted or renamed its instance variable properties
• Deleted or renamed enum value HealthState.ERROR
• Model LogAnalyticsQuerySignalDefinitionProperties deleted or renamed its instance variable labels
• Model LogAnalyticsQuerySignalDefinitionProperties deleted or renamed its instance variable deletion_date
• Model PrometheusMetricsSignalDefinitionProperties deleted or renamed its instance variable labels
• Model PrometheusMetricsSignalDefinitionProperties deleted or renamed its instance variable deletion_date
• Model RelationshipProperties deleted or renamed its instance variable labels
• Model RelationshipProperties deleted or renamed its instance variable deletion_date
• Model ResourceMetricSignalDefinitionProperties deleted or renamed its instance variable labels
• Model ResourceMetricSignalDefinitionProperties deleted or renamed its instance variable deletion_date
• Model SignalDefinitionProperties deleted or renamed its instance variable labels
• Model SignalDefinitionProperties deleted or renamed its instance variable deletion_date
• Deleted or renamed enum value SignalOperator.EQUALS
• Deleted or renamed enum value SignalOperator.GREATER_OR_EQUALS
• Deleted or renamed enum value SignalOperator.LOWER_OR_EQUALS
• Deleted or renamed enum value SignalOperator.LOWER_THAN
• Deleted or renamed model AzureMonitorWorkspaceSignalGroup
• Deleted or renamed model AzureResourceSignalGroup
• Deleted or renamed model DependenciesSignalGroup
• Deleted or renamed model DynamicDetectionRule
• Deleted or renamed model DynamicThresholdDirection
• Deleted or renamed model DynamicThresholdModel
• Deleted or renamed model HealthModelUpdateProperties
• Deleted or renamed model LogAnalyticsSignalGroup
• Deleted or renamed model ModelDiscoverySettings
• Deleted or renamed model SignalAssignment
• Deleted or renamed model SignalGroup
• Deleted or renamed model ThresholdRule
• Method AuthenticationSettingsOperations.create_or_update was converted to a long-running operation and renamed to begin_create_or_update
• Method AuthenticationSettingsOperations.delete was converted to a long-running operation and renamed to begin_delete
• Method DiscoveryRulesOperations.create_or_update was converted to a long-running operation and renamed to begin_create_or_update
• Method DiscoveryRulesOperations.delete was converted to a long-running operation and renamed to begin_delete
• Method EntitiesOperations.create_or_update was converted to a long-running operation and renamed to begin_create_or_update
• Method EntitiesOperations.delete was converted to a long-running operation and renamed to begin_delete
• Method RelationshipsOperations.create_or_update was converted to a long-running operation and renamed to begin_create_or_update
• Method RelationshipsOperations.delete was converted to a long-running operation and renamed to begin_delete
• Method SignalDefinitionsOperations.create_or_update was converted to a long-running operation and renamed to begin_create_or_update
• Method SignalDefinitionsOperations.delete was converted to a long-running operation and renamed to begin_delete

1.0.0b1 (2025-06-04)

Other Changes

• Initial version