DiscoveryRule Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models

Assembly:

Az.CloudHealth.private.dll

A discovery rule which automatically finds entities and relationships in a health model based on an Azure Resource Graph query

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.DiscoveryRuleTypeConverter))]
public class DiscoveryRule : Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IDiscoveryRule, Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.DiscoveryRuleTypeConverter))>]
type DiscoveryRule = class
    interface IDiscoveryRule
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
    interface IValidates

Public Class DiscoveryRule
Implements IDiscoveryRule, IValidates

Inheritance

Object

DiscoveryRule

Attributes

TypeConverterAttribute

Implements

IDiscoveryRule IProxyResource IResource IJsonSerializable IValidates

Constructors

Name	Description
DiscoveryRule()	Creates an new DiscoveryRule instance.

Properties

Name	Description
AddRecommendedSignal	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.
Context	Additional context information, like resource IDs or query details
DiscoverRelationship	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.
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Message	Error message
Name	The name of the resource
ProvisioningState	The status of the last operation.
ResourceGroupName	Gets the resource group name
Specification	Specification of the discovery rule defining how entities are discovered.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of DiscoveryRule.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of DiscoveryRule.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IDiscoveryRule.
FromJsonString(String)	Creates a new instance of DiscoveryRule, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of DiscoveryRule into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.