insights.azure.com/v1api20201001
ActivityLogAlert
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}
Used by: ActivityLogAlertList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | ActivityLogAlert_Spec Optional |
|
| status | ActivityLogAlert_STATUS Optional |
ActivityLogAlert_Spec
| Property | Description | Type |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActionList Required |
| 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 |
| condition | The condition that will cause this alert to activate. | AlertRuleAllOfCondition Required |
| description | A description of this Activity Log Alert rule. | string Optional |
| enabled | Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. | bool Optional |
| location | The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ActivityLogAlertOperatorSpec 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 |
| scopesReferences | A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. | genruntime.ResourceReference[] Required |
| tags | The tags of the resource. | map[string]string Optional |
ActivityLogAlert_STATUS
| Property | Description | Type |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActionList_STATUS Optional |
| condition | The condition that will cause this alert to activate. | AlertRuleAllOfCondition_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | A description of this Activity Log Alert rule. | string Optional |
| enabled | Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. | bool Optional |
| id | The resource Id. | string Optional |
| location | The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions. | string Optional |
| name | The name of the resource. | string Optional |
| scopes | A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. | string[] Optional |
| tags | The tags of the resource. | map[string]string Optional |
| type | The type of the resource. | string Optional |
ActivityLogAlertList
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | ActivityLogAlert[] Optional |
APIVersion
| Value | Description |
|---|---|
| “2020-10-01” |
ActivityLogAlert_Spec
Used by: ActivityLogAlert.
| Property | Description | Type |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActionList Required |
| 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 |
| condition | The condition that will cause this alert to activate. | AlertRuleAllOfCondition Required |
| description | A description of this Activity Log Alert rule. | string Optional |
| enabled | Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. | bool Optional |
| location | The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ActivityLogAlertOperatorSpec 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 |
| scopesReferences | A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. | genruntime.ResourceReference[] Required |
| tags | The tags of the resource. | map[string]string Optional |
ActivityLogAlert_STATUS
Used by: ActivityLogAlert.
| Property | Description | Type |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActionList_STATUS Optional |
| condition | The condition that will cause this alert to activate. | AlertRuleAllOfCondition_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | A description of this Activity Log Alert rule. | string Optional |
| enabled | Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. | bool Optional |
| id | The resource Id. | string Optional |
| location | The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions. | string Optional |
| name | The name of the resource. | string Optional |
| scopes | A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. | string[] Optional |
| tags | The tags of the resource. | map[string]string Optional |
| type | The type of the resource. | string Optional |
ActionList
A list of Activity Log Alert rule actions.
Used by: ActivityLogAlert_Spec.
| Property | Description | Type |
|---|---|---|
| actionGroups | The list of the Action Groups. | ActionGroupReference[] Optional |
ActionList_STATUS
A list of Activity Log Alert rule actions.
Used by: ActivityLogAlert_STATUS.
| Property | Description | Type |
|---|---|---|
| actionGroups | The list of the Action Groups. | ActionGroup_STATUS[] Optional |
ActivityLogAlertOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ActivityLogAlert_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 |
AlertRuleAllOfCondition
An Activity Log Alert rule condition that is met when all its member conditions are met.
Used by: ActivityLogAlert_Spec.
| Property | Description | Type |
|---|---|---|
| allOf | The list of Activity Log Alert rule conditions. | AlertRuleAnyOfOrLeafCondition[] Required |
AlertRuleAllOfCondition_STATUS
An Activity Log Alert rule condition that is met when all its member conditions are met.
Used by: ActivityLogAlert_STATUS.
| Property | Description | Type |
|---|---|---|
| allOf | The list of Activity Log Alert rule conditions. | AlertRuleAnyOfOrLeafCondition_STATUS[] Optional |
ActionGroup_STATUS
A pointer to an Azure Action Group.
Used by: ActionList_STATUS.
| Property | Description | Type |
|---|---|---|
| actionGroupId | The resource ID of the Action Group. This cannot be null or empty. | string Optional |
| webhookProperties | the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. | map[string]string Optional |
ActionGroupReference
A pointer to an Azure Action Group.
Used by: ActionList.
| Property | Description | Type |
|---|---|---|
| actionGroupReference | The resource ID of the Action Group. This cannot be null or empty. | genruntime.ResourceReference Required |
| webhookProperties | the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. | map[string]string Optional |
AlertRuleAnyOfOrLeafCondition
An Activity Log Alert rule condition that is met when all its member conditions are met. Each condition can be of one of the following types: Important: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition. * Leaf Condition - must contain field and either equals or containsAny. Please note, anyOf should not be set in a Leaf Condition. * AnyOf Condition - must contain only anyOf (which is an array of Leaf Conditions). _Please note, field, equals and containsAny should not be set in an AnyOf Condition._
Used by: AlertRuleAllOfCondition.
| Property | Description | Type |
|---|---|---|
| anyOf | An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. | AlertRuleLeafCondition[] Optional |
| containsAny | The value of the event’s field will be compared to the values in this array (case-insensitive) to determine if the condition is met. | string[] Optional |
| equals | The value of the event’s field will be compared to this value (case-insensitive) to determine if the condition is met. | string Optional |
| field | The name of the Activity Log event’s field that this condition will examine. The possible values for this field are (case-insensitive): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType, or anything beginning with properties. |
string Optional |
AlertRuleAnyOfOrLeafCondition_STATUS
An Activity Log Alert rule condition that is met when all its member conditions are met. Each condition can be of one of the following types: Important: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition. * Leaf Condition - must contain field and either equals or containsAny. Please note, anyOf should not be set in a Leaf Condition. * AnyOf Condition - must contain only anyOf (which is an array of Leaf Conditions). _Please note, field, equals and containsAny should not be set in an AnyOf Condition._
Used by: AlertRuleAllOfCondition_STATUS.
| Property | Description | Type |
|---|---|---|
| anyOf | An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. | AlertRuleLeafCondition_STATUS[] Optional |
| containsAny | The value of the event’s field will be compared to the values in this array (case-insensitive) to determine if the condition is met. | string[] Optional |
| equals | The value of the event’s field will be compared to this value (case-insensitive) to determine if the condition is met. | string Optional |
| field | The name of the Activity Log event’s field that this condition will examine. The possible values for this field are (case-insensitive): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType, or anything beginning with properties. |
string Optional |
AlertRuleLeafCondition
An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. This condition must contain field and either equals or containsAny.
Used by: AlertRuleAnyOfOrLeafCondition.
| Property | Description | Type |
|---|---|---|
| containsAny | The value of the event’s field will be compared to the values in this array (case-insensitive) to determine if the condition is met. | string[] Optional |
| equals | The value of the event’s field will be compared to this value (case-insensitive) to determine if the condition is met. | string Optional |
| field | The name of the Activity Log event’s field that this condition will examine. The possible values for this field are (case-insensitive): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType, or anything beginning with properties. |
string Optional |
AlertRuleLeafCondition_STATUS
An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. This condition must contain field and either equals or containsAny.
Used by: AlertRuleAnyOfOrLeafCondition_STATUS.
| Property | Description | Type |
|---|---|---|
| containsAny | The value of the event’s field will be compared to the values in this array (case-insensitive) to determine if the condition is met. | string[] Optional |
| equals | The value of the event’s field will be compared to this value (case-insensitive) to determine if the condition is met. | string Optional |
| field | The name of the Activity Log event’s field that this condition will examine. The possible values for this field are (case-insensitive): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType, or anything beginning with properties. |
string Optional |