insights.azure.com/v1api20240101preview

Package v1api20240101preview contains API Schema definitions for the insights v1api20240101preview API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2024-01-01-preview"

Actions

(Appears on:ScheduledQueryRule_Spec)

Actions to invoke when the alert fires.

Field	Description
`actionGroupsReferences` []genruntime.ResourceReference	ActionGroupsReferences: Action Group resource Ids to invoke when the alert fires.
`actionProperties` map[string]string	ActionProperties: The properties of an action properties.
`customProperties` map[string]string	CustomProperties: The properties of an alert payload.

Actions_STATUS

(Appears on:ScheduledQueryRule_STATUS)

Actions to invoke when the alert fires.

Field	Description
`actionGroups` []string	ActionGroups: Action Group resource Ids to invoke when the alert fires.
`actionProperties` map[string]string	ActionProperties: The properties of an action properties.
`customProperties` map[string]string	CustomProperties: The properties of an alert payload.

Condition

(Appears on:ScheduledQueryRuleCriteria)

A condition of the scheduled query rule.

Field	Description
`alertSensitivity` string	AlertSensitivity: The extent of deviation required to trigger an alert. Allowed values are ‘Low’, ‘Medium’ and ‘High’. This will affect how tight the threshold is to the metric series pattern. Relevant and required only for dynamic threshold rules of the kind LogAlert.
`criterionType` Condition_CriterionType	CriterionType: Specifies the type of threshold criteria
`dimensions` []Dimension	Dimensions: List of Dimensions conditions
`failingPeriods` Condition_FailingPeriods	FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
`ignoreDataBefore` string	IgnoreDataBefore: Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format). Relevant only for dynamic threshold rules of the kind LogAlert.
`metricMeasureColumn` string	MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
`metricName` string	MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
`operator` Condition_Operator	Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert.
`query` string	Query: Log query alert
`resourceIdColumnReference` genruntime.ResourceReference	ResourceIdColumnReference: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
`threshold` float64	Threshold: the criteria threshold value that activates the alert. Relevant and required only for static threshold rules of the kind LogAlert.
`timeAggregation` Condition_TimeAggregation	TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert.

Condition_CriterionType (`string` alias)

(Appears on:Condition)

Value	Description
"DynamicThresholdCriterion"
"StaticThresholdCriterion"

Condition_CriterionType_STATUS (`string` alias)

(Appears on:Condition_STATUS)

Value	Description
"DynamicThresholdCriterion"
"StaticThresholdCriterion"

Condition_FailingPeriods

(Appears on:Condition)

Field	Description
`minFailingPeriodsToAlert` int	MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
`numberOfEvaluationPeriods` int	NumberOfEvaluationPeriods: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

Condition_FailingPeriods_STATUS

(Appears on:Condition_STATUS)

Field	Description
`minFailingPeriodsToAlert` int	MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
`numberOfEvaluationPeriods` int	NumberOfEvaluationPeriods: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

Condition_Operator (`string` alias)

(Appears on:Condition)

Value	Description
"Equals"
"GreaterOrLessThan"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"

Condition_Operator_STATUS (`string` alias)

(Appears on:Condition_STATUS)

Value	Description
"Equals"
"GreaterOrLessThan"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"

Condition_STATUS

(Appears on:ScheduledQueryRuleCriteria_STATUS)

A condition of the scheduled query rule.

Field	Description
`alertSensitivity` string	AlertSensitivity: The extent of deviation required to trigger an alert. Allowed values are ‘Low’, ‘Medium’ and ‘High’. This will affect how tight the threshold is to the metric series pattern. Relevant and required only for dynamic threshold rules of the kind LogAlert.
`criterionType` Condition_CriterionType_STATUS	CriterionType: Specifies the type of threshold criteria
`dimensions` []Dimension_STATUS	Dimensions: List of Dimensions conditions
`failingPeriods` Condition_FailingPeriods_STATUS	FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
`ignoreDataBefore` string	IgnoreDataBefore: Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format). Relevant only for dynamic threshold rules of the kind LogAlert.
`metricMeasureColumn` string	MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
`metricName` string	MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
`operator` Condition_Operator_STATUS	Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert.
`query` string	Query: Log query alert
`resourceIdColumn` string	ResourceIdColumn: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
`threshold` float64	Threshold: the criteria threshold value that activates the alert. Relevant and required only for static threshold rules of the kind LogAlert.
`timeAggregation` Condition_TimeAggregation_STATUS	TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert.

Condition_TimeAggregation (`string` alias)

(Appears on:Condition)

Value	Description
"Average"
"Count"
"Maximum"
"Minimum"
"Total"

Condition_TimeAggregation_STATUS (`string` alias)

(Appears on:Condition_STATUS)

Value	Description
"Average"
"Count"
"Maximum"
"Minimum"
"Total"

Dimension

(Appears on:Condition)

Dimension splitting and filtering definition

Field	Description
`name` string	Name: Name of the dimension
`operator` Dimension_Operator	Operator: Operator for dimension values
`values` []string	Values: List of dimension values

Dimension_Operator (`string` alias)

(Appears on:Dimension)

Value	Description
"Exclude"
"Include"

Dimension_Operator_STATUS (`string` alias)

(Appears on:Dimension_STATUS)

Value	Description
"Exclude"
"Include"

Dimension_STATUS

(Appears on:Condition_STATUS)

Dimension splitting and filtering definition

Field	Description
`name` string	Name: Name of the dimension
`operator` Dimension_Operator_STATUS	Operator: Operator for dimension values
`values` []string	Values: List of dimension values

Identity

(Appears on:ScheduledQueryRule_Spec)

Identity for the resource.

Field	Description
`type` Identity_Type	Type: Type of managed service identity.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Identity_STATUS

(Appears on:ScheduledQueryRule_STATUS)

Identity for the resource.

Field	Description
`principalId` string	PrincipalId: The principal ID of resource identity.
`tenantId` string	TenantId: The tenant ID of resource.
`type` Identity_Type_STATUS	Type: Type of managed service identity.
`userAssignedIdentities` map[string]./api/insights/v1api20240101preview.UserIdentityProperties_STATUS	UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Identity_Type (`string` alias)

(Appears on:Identity)

Value	Description
"None"
"SystemAssigned"
"UserAssigned"

Identity_Type_STATUS (`string` alias)

(Appears on:Identity_STATUS)

Value	Description
"None"
"SystemAssigned"
"UserAssigned"

RuleResolveConfiguration

(Appears on:ScheduledQueryRule_Spec)

TBD. Relevant only for rules of the kind LogAlert.

Field	Description
`autoResolved` bool	AutoResolved: The flag that indicates whether or not to auto resolve a fired alert.
`timeToResolve` string	TimeToResolve: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

RuleResolveConfiguration_STATUS

(Appears on:ScheduledQueryRule_STATUS)

TBD. Relevant only for rules of the kind LogAlert.

Field	Description
`autoResolved` bool	AutoResolved: The flag that indicates whether or not to auto resolve a fired alert.
`timeToResolve` string	TimeToResolve: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

ScheduledQueryRule

Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/preview/2024-01-01-preview/scheduledQueryRule_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ScheduledQueryRule_Spec

`actions` Actions	Actions: Actions to invoke when the alert fires.
`autoMitigate` bool	AutoMitigate: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`checkWorkspaceAlertsStorageConfigured` bool	CheckWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule should be stored in the customer’s storage. The default is false. Relevant only for rules of the kind LogAlert.
`criteria` ScheduledQueryRuleCriteria	Criteria: The rule criteria that defines the conditions of the scheduled query rule.
`description` string	Description: The description of the scheduled query rule.
`displayName` string	DisplayName: The display name of the alert rule
`enabled` bool	Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
`evaluationFrequency` string	EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
`identity` Identity	Identity: The identity of the resource.
`kind` ScheduledQueryRule_Kind_Spec	Kind: Indicates the type of scheduled query rule. The default is LogAlert.
`location` string	Location: The geo-location where the resource lives
`muteActionsDuration` string	MuteActionsDuration: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
`operatorSpec` ScheduledQueryRuleOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`overrideQueryTimeRange` string	OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`resolveConfiguration` RuleResolveConfiguration	ResolveConfiguration: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
`scopesReferences` []genruntime.ResourceReference	ScopesReferences: The list of resource id’s that this scheduled query rule is scoped to.
`severity` ScheduledQueryRuleProperties_Severity	Severity: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
`skipQueryValidation` bool	SkipQueryValidation: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
`tags` map[string]string	Tags: Resource tags.
`targetResourceTypes` []string	TargetResourceTypes: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
`windowSize` string	WindowSize: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

status
ScheduledQueryRule_STATUS

ScheduledQueryRuleCriteria

(Appears on:ScheduledQueryRule_Spec)

The rule criteria that defines the conditions of the scheduled query rule.

Field	Description
`allOf` []Condition	AllOf: A list of conditions to evaluate against the specified scopes

ScheduledQueryRuleCriteria_STATUS

(Appears on:ScheduledQueryRule_STATUS)

The rule criteria that defines the conditions of the scheduled query rule.

Field	Description
`allOf` []Condition_STATUS	AllOf: A list of conditions to evaluate against the specified scopes

ScheduledQueryRuleOperatorSpec

(Appears on:ScheduledQueryRule_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

ScheduledQueryRuleProperties_Severity (`int` alias)

(Appears on:ScheduledQueryRule_Spec)

Value	Description
0
1
2
3
4

ScheduledQueryRuleProperties_Severity_STATUS (`int` alias)

(Appears on:ScheduledQueryRule_STATUS)

Value	Description
0
1
2
3
4

ScheduledQueryRule_Kind_STATUS (`string` alias)

(Appears on:ScheduledQueryRule_STATUS)

Value	Description
"EventLogAlert"
"LogAlert"
"LogToMetric"

ScheduledQueryRule_Kind_Spec (`string` alias)

(Appears on:ScheduledQueryRule_Spec)

Value	Description
"EventLogAlert"
"LogAlert"
"LogToMetric"

ScheduledQueryRule_STATUS

(Appears on:ScheduledQueryRule)

Field	Description
`actions` Actions_STATUS	Actions: Actions to invoke when the alert fires.
`autoMitigate` bool	AutoMitigate: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
`checkWorkspaceAlertsStorageConfigured` bool	CheckWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule should be stored in the customer’s storage. The default is false. Relevant only for rules of the kind LogAlert.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`createdWithApiVersion` string	CreatedWithApiVersion: The api-version used when creating this alert rule
`criteria` ScheduledQueryRuleCriteria_STATUS	Criteria: The rule criteria that defines the conditions of the scheduled query rule.
`description` string	Description: The description of the scheduled query rule.
`displayName` string	DisplayName: The display name of the alert rule
`enabled` bool	Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
`etag` string	Etag: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
`evaluationFrequency` string	EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` Identity_STATUS	Identity: The identity of the resource.
`isLegacyLogAnalyticsRule` bool	IsLegacyLogAnalyticsRule: True if alert rule is legacy Log Analytic rule
`isWorkspaceAlertsStorageConfigured` bool	IsWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer’s storage. The default is false.
`kind` ScheduledQueryRule_Kind_STATUS	Kind: Indicates the type of scheduled query rule. The default is LogAlert.
`location` string	Location: The geo-location where the resource lives
`muteActionsDuration` string	MuteActionsDuration: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
`name` string	Name: The name of the resource
`overrideQueryTimeRange` string	OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
`resolveConfiguration` RuleResolveConfiguration_STATUS	ResolveConfiguration: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
`scopes` []string	Scopes: The list of resource id’s that this scheduled query rule is scoped to.
`severity` ScheduledQueryRuleProperties_Severity_STATUS	Severity: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
`skipQueryValidation` bool	SkipQueryValidation: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
`systemData` SystemData_STATUS	SystemData: SystemData of ScheduledQueryRule.
`tags` map[string]string	Tags: Resource tags.
`targetResourceTypes` []string	TargetResourceTypes: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`windowSize` string	WindowSize: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

ScheduledQueryRule_Spec

(Appears on:ScheduledQueryRule)

Field	Description
`actions` Actions	Actions: Actions to invoke when the alert fires.
`autoMitigate` bool	AutoMitigate: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`checkWorkspaceAlertsStorageConfigured` bool	CheckWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule should be stored in the customer’s storage. The default is false. Relevant only for rules of the kind LogAlert.
`criteria` ScheduledQueryRuleCriteria	Criteria: The rule criteria that defines the conditions of the scheduled query rule.
`description` string	Description: The description of the scheduled query rule.
`displayName` string	DisplayName: The display name of the alert rule
`enabled` bool	Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
`evaluationFrequency` string	EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
`identity` Identity	Identity: The identity of the resource.
`kind` ScheduledQueryRule_Kind_Spec	Kind: Indicates the type of scheduled query rule. The default is LogAlert.
`location` string	Location: The geo-location where the resource lives
`muteActionsDuration` string	MuteActionsDuration: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
`operatorSpec` ScheduledQueryRuleOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`overrideQueryTimeRange` string	OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`resolveConfiguration` RuleResolveConfiguration	ResolveConfiguration: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
`scopesReferences` []genruntime.ResourceReference	ScopesReferences: The list of resource id’s that this scheduled query rule is scoped to.
`severity` ScheduledQueryRuleProperties_Severity	Severity: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
`skipQueryValidation` bool	SkipQueryValidation: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
`tags` map[string]string	Tags: Resource tags.
`targetResourceTypes` []string	TargetResourceTypes: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
`windowSize` string	WindowSize: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:ScheduledQueryRule_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

UserAssignedIdentityDetails

(Appears on:Identity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserIdentityProperties_STATUS

(Appears on:Identity_STATUS)

User assigned identity properties.

Field	Description
`clientId` string	ClientId: The client id of user assigned identity.
`principalId` string	PrincipalId: The principal id of user assigned identity.

insights.azure.com/v1api20240101preview