DiscoveryRuleProperties interface

Package:

@azure/arm-cloudhealth

Discovery rule properties

Properties

addRecommendedSignals	Whether to add all recommended signals to the discovered entities.
addResourceHealthSignal	Whether to automatically add a signal for the Azure resource's availability state from Azure Resource Health to the discovered entities. Defaults to Enabled: discovery rules updated via this API version without setting this field will begin emitting a Resource Health availability signal. Pass Disabled to preserve pre-2026-05-01-preview behavior.
authenticationSetting	Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities.
discoverRelationships	Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted.
displayName	Display name
entityName	Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created.
error	Error details if the last discovery operation failed.
provisioningState	The status of the last operation.
specification	Specification of the discovery rule defining how entities are discovered.

Property Details

addRecommendedSignals

Whether to add all recommended signals to the discovered entities.

addRecommendedSignals: string

Property Value

string

addResourceHealthSignal

Whether to automatically add a signal for the Azure resource's availability state from Azure Resource Health to the discovered entities. Defaults to Enabled: discovery rules updated via this API version without setting this field will begin emitting a Resource Health availability signal. Pass Disabled to preserve pre-2026-05-01-preview behavior.

addResourceHealthSignal?: string

Property Value

string

authenticationSetting

Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities.

authenticationSetting: string

Property Value

string

discoverRelationships

Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted.

discoverRelationships: string

Property Value

string

displayName

Display name

displayName?: string

Property Value

string

entityName

Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created.

entityName?: string

Property Value

string

error

Error details if the last discovery operation failed.

error?: DiscoveryError

Property Value

DiscoveryError

provisioningState

The status of the last operation.

provisioningState?: string

Property Value

string

specification

Specification of the discovery rule defining how entities are discovered.

specification: DiscoveryRuleSpecificationUnion

Property Value

DiscoveryRuleSpecificationUnion