insights.azure.com/v1api20240101preview
APIVersion
| Value | Description |
|---|---|
| “2024-01-01-preview” |
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}
Used by: ScheduledQueryRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | ScheduledQueryRule_Spec Optional |
|
| status | ScheduledQueryRule_STATUS Optional |
ScheduledQueryRule_Spec
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions Optional |
| 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. | bool Optional |
| 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. | string Optional |
| 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. | bool Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| 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. | string Optional |
| identity | The identity of the resource. | Identity Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_Spec Optional |
| location | The geo-location where the resource lives | string Required |
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ScheduledQueryRuleOperatorSpec Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| 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 | genruntime.KnownResourceReference Required |
| resolveConfiguration | Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. | RuleResolveConfiguration Optional |
| scopesReferences | The list of resource id’s that this scheduled query rule is scoped to. | genruntime.ResourceReference[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity Optional |
| 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. | bool Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| 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. | string Optional |
ScheduledQueryRule_STATUS
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions_STATUS Optional |
| 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. | bool Optional |
| 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. | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdWithApiVersion | The api-version used when creating this alert rule | string Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria_STATUS Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| 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. | string Optional |
| 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. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the resource. | Identity_STATUS Optional |
| isLegacyLogAnalyticsRule | True if alert rule is legacy Log Analytic rule | bool Optional |
| 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. | bool Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | string Optional |
| name | The name of the resource | string Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| resolveConfiguration | Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. | RuleResolveConfiguration_STATUS Optional |
| scopes | The list of resource id’s that this scheduled query rule is scoped to. | string[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity_STATUS Optional |
| 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. | bool Optional |
| systemData | SystemData of ScheduledQueryRule. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| 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. | string Optional |
ScheduledQueryRuleList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | ScheduledQueryRule[] Optional |
ScheduledQueryRule_Spec
Used by: ScheduledQueryRule.
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions Optional |
| 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. | bool Optional |
| 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. | string Optional |
| 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. | bool Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| 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. | string Optional |
| identity | The identity of the resource. | Identity Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_Spec Optional |
| location | The geo-location where the resource lives | string Required |
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ScheduledQueryRuleOperatorSpec Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| 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 | genruntime.KnownResourceReference Required |
| resolveConfiguration | Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. | RuleResolveConfiguration Optional |
| scopesReferences | The list of resource id’s that this scheduled query rule is scoped to. | genruntime.ResourceReference[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity Optional |
| 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. | bool Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| 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. | string Optional |
ScheduledQueryRule_STATUS
Used by: ScheduledQueryRule.
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions_STATUS Optional |
| 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. | bool Optional |
| 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. | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdWithApiVersion | The api-version used when creating this alert rule | string Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria_STATUS Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| 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. | string Optional |
| 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. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the resource. | Identity_STATUS Optional |
| isLegacyLogAnalyticsRule | True if alert rule is legacy Log Analytic rule | bool Optional |
| 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. | bool Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | string Optional |
| name | The name of the resource | string Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| resolveConfiguration | Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. | RuleResolveConfiguration_STATUS Optional |
| scopes | The list of resource id’s that this scheduled query rule is scoped to. | string[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity_STATUS Optional |
| 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. | bool Optional |
| systemData | SystemData of ScheduledQueryRule. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| 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. | string Optional |
Actions
Actions to invoke when the alert fires.
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| actionGroupsReferences | Action Group resource Ids to invoke when the alert fires. | genruntime.ResourceReference[] Optional |
| actionProperties | The properties of an action properties. | map[string]string Optional |
| customProperties | The properties of an alert payload. | map[string]string Optional |
Actions_STATUS
Actions to invoke when the alert fires.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| actionGroups | Action Group resource Ids to invoke when the alert fires. | string[] Optional |
| actionProperties | The properties of an action properties. | map[string]string Optional |
| customProperties | The properties of an alert payload. | map[string]string Optional |
Identity
Identity for the resource.
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity. | Identity_Type Required |
| 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}’. | UserAssignedIdentityDetails[] Optional |
Identity_STATUS
Identity for the resource.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of resource identity. | string Optional |
| tenantId | The tenant ID of resource. | string Optional |
| type | Type of managed service identity. | Identity_Type_STATUS Optional |
| 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}’. | map[string]UserIdentityProperties_STATUS Optional |
RuleResolveConfiguration
TBD. Relevant only for rules of the kind LogAlert.
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| autoResolved | The flag that indicates whether or not to auto resolve a fired alert. | bool Optional |
| timeToResolve | The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format. | string Optional |
RuleResolveConfiguration_STATUS
TBD. Relevant only for rules of the kind LogAlert.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| autoResolved | The flag that indicates whether or not to auto resolve a fired alert. | bool Optional |
| timeToResolve | The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format. | string Optional |
ScheduledQueryRule_Kind_Spec
Used by: ScheduledQueryRule_Spec.
| Value | Description |
|---|---|
| “EventLogAlert” | |
| “LogAlert” | |
| “LogToMetric” |
ScheduledQueryRule_Kind_STATUS
Used by: ScheduledQueryRule_STATUS.
| Value | Description |
|---|---|
| “EventLogAlert” | |
| “LogAlert” | |
| “LogToMetric” |
ScheduledQueryRuleCriteria
The rule criteria that defines the conditions of the scheduled query rule.
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| allOf | A list of conditions to evaluate against the specified scopes | Condition[] Optional |
ScheduledQueryRuleCriteria_STATUS
The rule criteria that defines the conditions of the scheduled query rule.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| allOf | A list of conditions to evaluate against the specified scopes | Condition_STATUS[] Optional |
ScheduledQueryRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ScheduledQueryRuleProperties_Severity
Used by: ScheduledQueryRule_Spec.
| Value | Description |
|---|---|
| 0 | |
| 1 | |
| 2 | |
| 3 | |
| 4 |
ScheduledQueryRuleProperties_Severity_STATUS
Used by: ScheduledQueryRule_STATUS.
| Value | Description |
|---|---|
| 0 | |
| 1 | |
| 2 | |
| 3 | |
| 4 |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
Condition
A condition of the scheduled query rule.
Used by: ScheduledQueryRuleCriteria.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| criterionType | Specifies the type of threshold criteria | Condition_CriterionType Optional |
| dimensions | List of Dimensions conditions | Dimension[] Optional |
| 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. | Condition_FailingPeriods Optional |
| 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. | string Optional |
| metricMeasureColumn | The column containing the metric measure number. Relevant only for rules of the kind LogAlert. | string Optional |
| metricName | The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. | string Optional |
| operator | The criteria operator. Relevant and required only for rules of the kind LogAlert. | Condition_Operator Optional |
| query | Log query alert | string Optional |
| 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. | genruntime.ResourceReference Optional |
| threshold | the criteria threshold value that activates the alert. Relevant and required only for static threshold rules of the kind LogAlert. | float64 Optional |
| timeAggregation | Aggregation type. Relevant and required only for rules of the kind LogAlert. | Condition_TimeAggregation Optional |
Condition_STATUS
A condition of the scheduled query rule.
Used by: ScheduledQueryRuleCriteria_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| criterionType | Specifies the type of threshold criteria | Condition_CriterionType_STATUS Optional |
| dimensions | List of Dimensions conditions | Dimension_STATUS[] Optional |
| 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. | Condition_FailingPeriods_STATUS Optional |
| 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. | string Optional |
| metricMeasureColumn | The column containing the metric measure number. Relevant only for rules of the kind LogAlert. | string Optional |
| metricName | The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. | string Optional |
| operator | The criteria operator. Relevant and required only for rules of the kind LogAlert. | Condition_Operator_STATUS Optional |
| query | Log query alert | string Optional |
| 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. | string Optional |
| threshold | the criteria threshold value that activates the alert. Relevant and required only for static threshold rules of the kind LogAlert. | float64 Optional |
| timeAggregation | Aggregation type. Relevant and required only for rules of the kind LogAlert. | Condition_TimeAggregation_STATUS Optional |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “UserAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “UserAssigned” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: Identity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserIdentityProperties_STATUS
User assigned identity properties.
Used by: Identity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client id of user assigned identity. | string Optional |
| principalId | The principal id of user assigned identity. | string Optional |
Condition_CriterionType
Used by: Condition.
| Value | Description |
|---|---|
| “DynamicThresholdCriterion” | |
| “StaticThresholdCriterion” |
Condition_CriterionType_STATUS
Used by: Condition_STATUS.
| Value | Description |
|---|---|
| “DynamicThresholdCriterion” | |
| “StaticThresholdCriterion” |
Condition_FailingPeriods
Used by: Condition.
| Property | Description | Type |
|---|---|---|
| minFailingPeriodsToAlert | The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 | int Optional |
| 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 | int Optional |
Condition_FailingPeriods_STATUS
Used by: Condition_STATUS.
| Property | Description | Type |
|---|---|---|
| minFailingPeriodsToAlert | The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 | int Optional |
| 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 | int Optional |
Condition_Operator
Used by: Condition.
| Value | Description |
|---|---|
| “Equals” | |
| “GreaterOrLessThan” | |
| “GreaterThan” | |
| “GreaterThanOrEqual” | |
| “LessThan” | |
| “LessThanOrEqual” |
Condition_Operator_STATUS
Used by: Condition_STATUS.
| Value | Description |
|---|---|
| “Equals” | |
| “GreaterOrLessThan” | |
| “GreaterThan” | |
| “GreaterThanOrEqual” | |
| “LessThan” | |
| “LessThanOrEqual” |
Condition_TimeAggregation
Used by: Condition.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Maximum” | |
| “Minimum” | |
| “Total” |
Condition_TimeAggregation_STATUS
Used by: Condition_STATUS.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Maximum” | |
| “Minimum” | |
| “Total” |
Dimension
Dimension splitting and filtering definition
Used by: Condition.
| Property | Description | Type |
|---|---|---|
| name | Name of the dimension | string Required |
| operator | Operator for dimension values | Dimension_Operator Required |
| values | List of dimension values | string[] Required |
Dimension_STATUS
Dimension splitting and filtering definition
Used by: Condition_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name of the dimension | string Optional |
| operator | Operator for dimension values | Dimension_Operator_STATUS Optional |
| values | List of dimension values | string[] Optional |
Dimension_Operator
Used by: Dimension.
| Value | Description |
|---|---|
| “Exclude” | |
| “Include” |
Dimension_Operator_STATUS
Used by: Dimension_STATUS.
| Value | Description |
|---|---|
| “Exclude” | |
| “Include” |