@azure/arm-cloudhealth_1.0.0-beta.2
Breaking Changes📦 azure-monitorView on GitHub →
⚠ 26 breaking✨ 65 features🔧 83 symbols
Summary
This beta release introduces a large set of new interfaces and operations related to signals, health reports, and discovery rules. It also contains substantial breaking changes involving the removal of several older interface types and modifications to existing property types and operation signatures.
⚠️ 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 these parameters from usage.
- Interface EntityProperties no longer has parameter deletionDate, kind, labels, or signals. Remove these parameters from usage.
- Interface EvaluationRule no longer has parameter dynamicDetectionRule. Remove this parameter from usage.
- Interface HealthModelProperties no longer has parameter dataplaneEndpoint or discovery. Remove these parameters from usage.
- Interface HealthModelUpdate no longer has parameter properties. Remove this parameter from usage.
- Interface LogAnalyticsQuerySignalDefinitionProperties no longer has parameter deletionDate or labels. Remove these parameters from usage.
- Interface PrometheusMetricsSignalDefinitionProperties no longer has parameter deletionDate or labels. Remove these parameters from usage.
- Interface RelationshipProperties no longer has parameter deletionDate or labels. Remove these parameters from usage.
- Interface ResourceMetricSignalDefinitionProperties no longer has parameter deletionDate or labels. Remove these parameters from usage.
- Interface SignalDefinitionProperties no longer has parameter deletionDate or labels. Remove these parameters from usage.
- Parameter 'unhealthyRule' in interface EvaluationRule is now required. Ensure this parameter is always provided.
- Enum KnownDependenciesAggregationType no longer has value Thresholds. Update code using this value.
- Enum KnownHealthState no longer has value Error. Update code using this value.
- Enum KnownSignalOperator no longer has value Equals. Update code using this value.
- Enum KnownSignalOperator no longer has value GreaterOrEquals. Update code using this value.
- Enum KnownSignalOperator no longer has value LowerOrEquals. Update code using this value.
- Enum KnownSignalOperator no longer has value LowerThan. Update code using this value.
Migration Steps
- If you were using removed interfaces (e.g., AzureResourceSignalGroup, ThresholdRule), update your code to use the newly introduced replacements (e.g., ThresholdRuleV2).
- Ensure that the 'specification' parameter is provided when interacting with DiscoveryRuleProperties.
- Update calls to DiscoveryRules.createOrUpdate, get, and listByHealthModel, and SignalDefinitions.createOrUpdate, get, and listByHealthModel due to signature changes.
✨ 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 new values MaxNotHealthy and MinHealthy.
- Enum KnownHealthState gained new value Unhealthy.
- Enum KnownSignalKind gained new value ExternalSignal.
- Enum KnownSignalOperator gained new values Equal, GreaterThanOrEqual, LessThan, LessThanOrEqual, and NotEqual.
- Added Enum KnownVersions with value V20260101Preview.
Affected Symbols
EntitiesOperations.getHistoryEntitiesOperations.getSignalHistoryEntitiesOperations.ingestHealthReportApplicationInsightsTopologySpecificationAzureMonitorWorkspaceSignalsAzureResourceSignalAzureResourceSignalsDependenciesSignalGroupV2DiscoveryErrorDiscoveryRulePropertiesCreateDiscoveryRuleResourceCreateDiscoveryRuleSpecificationEntitiesGetHistoryOptionalParamsEntitiesGetSignalHistoryOptionalParamsEntitiesIngestHealthReportOptionalParamsEntityHistoryRequestEntityHistoryResponseExternalSignalExternalSignalGroupHealthReportEvaluationRuleHealthReportRequestHealthStateTransitionLogAnalyticsSignalLogAnalyticsSignalsPrometheusMetricsSignalResourceGraphQuerySpecificationSignalGroupsSignalHistoryDataPointSignalHistoryRequestSignalHistoryResponseSignalInstancePropertiesSignalStatusThresholdRuleV2AuthenticationSettingsCreateOrUpdateOptionalParamsAuthenticationSettingsDeleteOptionalParamsCloudHealthClientOptionalParamsDiscoveryRulePropertiesDiscoveryRulesCreateOrUpdateOptionalParamsDiscoveryRulesDeleteOptionalParamsEntitiesCreateOrUpdateOptionalParamsEntitiesDeleteOptionalParamsEntityPropertiesLogAnalyticsQuerySignalDefinitionPropertiesPrometheusMetricsSignalDefinitionPropertiesRelationshipPropertiesRelationshipsCreateOrUpdateOptionalParamsRelationshipsDeleteOptionalParamsResourceMetricSignalDefinitionPropertiesSignalDefinitionPropertiesSignalDefinitionsCreateOrUpdateOptionalParamsSignalDefinitionsDeleteOptionalParamsAzureSupportedCloudsDependenciesAggregationUnitDiscoveryRuleKindDiscoveryRuleSpecificationUnionSignalInstancePropertiesUnionAzureCloudsKnownDependenciesAggregationUnitKnownDiscoveryRuleKindKnownDependenciesAggregationTypeKnownHealthStateKnownSignalKindKnownSignalOperatorKnownVersionsDiscoveryRules.createOrUpdateDiscoveryRules.getDiscoveryRules.listByHealthModelSignalDefinitions.createOrUpdateSignalDefinitions.getSignalDefinitions.listByHealthModelAzureMonitorWorkspaceSignalGroupAzureResourceSignalGroupDependenciesSignalGroupDynamicDetectionRuleHealthModelUpdatePropertiesLogAnalyticsSignalGroupModelDiscoverySettingsSignalAssignmentSignalGroupThresholdRuleEvaluationRuleHealthModelPropertiesHealthModelUpdate