@azure/arm-cloudhealth_1.0.0-beta.2

Breaking Changes

📅 Jun 15, 2026📦 azure-api-managementView on GitHub →

⚠ 19 breaking✨ 65 features🔧 87 symbols

Summary

This beta release introduces extensive new interfaces and operations related to entity history, signals, and health reporting. It also includes significant breaking changes involving the removal of several older interface types and modifications to required parameters and type definitions across various properties.

⚠️ Breaking Changes

Operation DiscoveryRules.createOrUpdate has a new signature. Review parameter usage.
Operation DiscoveryRules.get has a new signature. Review parameter usage.
Operation DiscoveryRules.listByHealthModel has a new signature. Review parameter usage.
Operation SignalDefinitions.createOrUpdate has a new signature. Review parameter usage.
Operation SignalDefinitions.get has a new signature. Review parameter usage.
Operation SignalDefinitions.listByHealthModel has a new signature. Review parameter usage.
Interface DiscoveryRuleProperties now requires the parameter 'specification'. Add this parameter to existing calls.
The type of parameter 'degradedRule' in interface EvaluationRule changed from ThresholdRule to ThresholdRuleV2. Update usage to use ThresholdRuleV2.
The type of parameter 'unhealthyRule' in interface EvaluationRule changed from ThresholdRule to ThresholdRuleV2. Update usage to use ThresholdRuleV2.
Interface DiscoveryRuleProperties no longer has parameter deletionDate, errorMessage, numberOfDiscoveredEntities, or resourceGraphQuery. Remove usage of these fields.
Interface EntityProperties no longer has parameter deletionDate, kind, labels, or signals. Remove usage of these fields.
Interface EvaluationRule no longer has parameter dynamicDetectionRule. Remove usage of this field.
Interface HealthModelProperties no longer has parameter dataplaneEndpoint or discovery. Remove usage of these fields.
Interface HealthModelUpdate no longer has parameter properties. Remove usage of this field.
Interfaces LogAnalyticsQuerySignalDefinitionProperties, PrometheusMetricsSignalDefinitionProperties, ResourceMetricSignalDefinitionProperties, RelationshipProperties, and SignalDefinitionProperties no longer have parameter deletionDate or labels. Remove usage of these fields.
Parameter 'unhealthyRule' in interface EvaluationRule is now required. Ensure this parameter is always provided.
Enum KnownDependenciesAggregationType no longer has value Thresholds. Update code that relies on this value.
Enum KnownHealthState no longer has value Error. Update code that relies on this value.
Enum KnownSignalOperator no longer has values Equals, GreaterOrEquals, LowerOrEquals, or LowerThan. Update code using these specific enum values.

Migration Steps

Ensure that 'specification' is provided when using DiscoveryRuleProperties.
Update usages of EvaluationRule to use ThresholdRuleV2 for 'degradedRule' and 'unhealthyRule' parameters.
Ensure that 'unhealthyRule' is provided for EvaluationRule as it is now required.

✨ New Features

Added operation EntitiesOperations.getHistory
Added operation EntitiesOperations.getSignalHistory
Added operation EntitiesOperations.ingestHealthReport
Added Interface ApplicationInsightsTopologySpecification
Added Interface AzureMonitorWorkspaceSignals
Added Interface AzureResourceSignal
Added Interface AzureResourceSignals
Added Interface DependenciesSignalGroupV2
Added Interface DiscoveryError
Added Interface DiscoveryRulePropertiesCreate
Added Interface DiscoveryRuleResourceCreate
Added Interface DiscoveryRuleSpecification
Added Interface EntitiesGetHistoryOptionalParams
Added Interface EntitiesGetSignalHistoryOptionalParams
Added Interface EntitiesIngestHealthReportOptionalParams
Added Interface EntityHistoryRequest
Added Interface EntityHistoryResponse
Added Interface ExternalSignal
Added Interface ExternalSignalGroup
Added Interface HealthReportEvaluationRule
Added Interface HealthReportRequest
Added Interface HealthStateTransition
Added Interface LogAnalyticsSignal
Added Interface LogAnalyticsSignals
Added Interface PrometheusMetricsSignal
Added Interface ResourceGraphQuerySpecification
Added Interface SignalGroups
Added Interface SignalHistoryDataPoint
Added Interface SignalHistoryRequest
Added Interface SignalHistoryResponse
Added Interface SignalInstanceProperties
Added Interface SignalStatus
Added Interface ThresholdRuleV2
Interface AuthenticationSettingsCreateOrUpdateOptionalParams gained optional parameter updateIntervalInMs
Interface AuthenticationSettingsDeleteOptionalParams gained optional parameter updateIntervalInMs
Interface CloudHealthClientOptionalParams gained optional parameter cloudSetting
Interface DiscoveryRuleProperties gained optional parameter error
Interface DiscoveryRulesCreateOrUpdateOptionalParams gained optional parameter updateIntervalInMs
Interface DiscoveryRulesDeleteOptionalParams gained optional parameter updateIntervalInMs
Interface EntitiesCreateOrUpdateOptionalParams gained optional parameter updateIntervalInMs
Interface EntitiesDeleteOptionalParams gained optional parameter updateIntervalInMs
Interface EntityProperties gained optional parameter signalGroups
Interface EntityProperties gained optional parameter tags
Interface LogAnalyticsQuerySignalDefinitionProperties gained optional parameter tags
Interface PrometheusMetricsSignalDefinitionProperties gained optional parameter tags
Interface RelationshipProperties gained optional parameter tags
Interface RelationshipsCreateOrUpdateOptionalParams gained optional parameter updateIntervalInMs
Interface RelationshipsDeleteOptionalParams gained optional parameter updateIntervalInMs
Interface ResourceMetricSignalDefinitionProperties gained optional parameter tags
Interface SignalDefinitionProperties gained optional parameter tags
Interface SignalDefinitionsCreateOrUpdateOptionalParams gained optional parameter updateIntervalInMs
Interface SignalDefinitionsDeleteOptionalParams gained optional parameter updateIntervalInMs
Added Type Alias AzureSupportedClouds
Added Type Alias DependenciesAggregationUnit
Added Type Alias DiscoveryRuleKind
Added Type Alias DiscoveryRuleSpecificationUnion
Added Type Alias SignalInstancePropertiesUnion
Added Enum AzureClouds
Added Enum KnownDependenciesAggregationUnit
Added Enum KnownDiscoveryRuleKind
Enum KnownDependenciesAggregationType gained values MaxNotHealthy and MinHealthy
Enum KnownHealthState gained value Unhealthy
Enum KnownSignalKind gained value ExternalSignal
Enum KnownSignalOperator gained values Equal, GreaterThanOrEqual, LessThan, LessThanOrEqual, and NotEqual
Enum KnownVersions gained value V20260101Preview

Affected Symbols

EntitiesOperations.getHistory EntitiesOperations.getSignalHistory EntitiesOperations.ingestHealthReport ApplicationInsightsTopologySpecification AzureMonitorWorkspaceSignals AzureResourceSignal AzureResourceSignals DependenciesSignalGroupV2 DiscoveryError DiscoveryRulePropertiesCreate DiscoveryRuleResourceCreate DiscoveryRuleSpecification EntitiesGetHistoryOptionalParams EntitiesGetSignalHistoryOptionalParams EntitiesIngestHealthReportOptionalParams EntityHistoryRequest EntityHistoryResponse ExternalSignal ExternalSignalGroup HealthReportEvaluationRule HealthReportRequest HealthStateTransition LogAnalyticsSignal LogAnalyticsSignals PrometheusMetricsSignal ResourceGraphQuerySpecification SignalGroups SignalHistoryDataPoint SignalHistoryRequest SignalHistoryResponse SignalInstanceProperties SignalStatus ThresholdRuleV2 AuthenticationSettingsCreateOrUpdateOptionalParams AuthenticationSettingsDeleteOptionalParams CloudHealthClientOptionalParams DiscoveryRuleProperties DiscoveryRulesCreateOrUpdateOptionalParams DiscoveryRulesDeleteOptionalParams EntitiesCreateOrUpdateOptionalParams EntitiesDeleteOptionalParams EntityProperties LogAnalyticsQuerySignalDefinitionProperties PrometheusMetricsSignalDefinitionProperties RelationshipProperties RelationshipsCreateOrUpdateOptionalParams RelationshipsDeleteOptionalParams ResourceMetricSignalDefinitionProperties SignalDefinitionProperties SignalDefinitionsCreateOrUpdateOptionalParams SignalDefinitionsDeleteOptionalParams AzureSupportedClouds DependenciesAggregationUnit DiscoveryRuleKind DiscoveryRuleSpecificationUnion SignalInstancePropertiesUnion AzureClouds KnownDependenciesAggregationUnit KnownDiscoveryRuleKind KnownDependenciesAggregationType KnownHealthState KnownSignalKind KnownSignalOperator KnownVersions DiscoveryRules.createOrUpdate DiscoveryRules.get DiscoveryRules.listByHealthModel SignalDefinitions.createOrUpdate SignalDefinitions.get SignalDefinitions.listByHealthModel AzureMonitorWorkspaceSignalGroup AzureResourceSignalGroup DependenciesSignalGroup DynamicDetectionRule HealthModelUpdateProperties LogAnalyticsSignalGroup ModelDiscoverySettings SignalAssignment SignalGroup ThresholdRule EvaluationRule HealthModelProperties HealthModelUpdate DynamicThresholdDirection DynamicThresholdModel KnownDynamicThresholdDirection KnownDynamicThresholdModel