Share via

SummaryLogs interface

Package:
@azure/arm-operationalinsights

Workspace data summary rules definition.

Extends
ProxyResourceAutoGenerated

Properties

description

The description of the Summary rule.
displayName

The display name of the Summary rule.
isActive

Indicates if Summary rule is active. If not, Summary rule execution stops. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Summary rule is in provisioning state. If set to 'updating' or 'deleting', indicates a resource lock due to an ongoing operation, preventing any update to the Summary rule until the operation is complete. NOTE: This property will not be serialized. It can only be populated by the server.
ruleDefinition

Rule definition parameters.
ruleType

SummaryRules rule type: User.
statusCode

Indicates the reason for rule deactivation. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

The description of the Summary rule.

description?: string

Property Value

string

displayName

The display name of the Summary rule.

displayName?: string

Property Value

string

isActive

Indicates if Summary rule is active. If not, Summary rule execution stops. NOTE: This property will not be serialized. It can only be populated by the server.

isActive?: boolean

Property Value

boolean

provisioningState

Summary rule is in provisioning state. If set to 'updating' or 'deleting', indicates a resource lock due to an ongoing operation, preventing any update to the Summary rule until the operation is complete. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

ruleDefinition

Rule definition parameters.

ruleDefinition?: RuleDefinition

Property Value

RuleDefinition

ruleType

SummaryRules rule type: User.

ruleType?: string

Property Value

string

statusCode

Indicates the reason for rule deactivation. NOTE: This property will not be serialized. It can only be populated by the server.

statusCode?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResourceAutoGenerated.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResourceAutoGenerated.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResourceAutoGenerated.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResourceAutoGenerated.type