alertsmanagement.azure.com/v1api20210401
APIVersion
| Value | Description |
|---|---|
| “2021-04-01” |
SmartDetectorAlertRule
Generator information: - Generated from: /alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-04-01/SmartDetectorAlertRulesApi.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
Used by: SmartDetectorAlertRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | SmartDetectorAlertRule_Spec Optional |
|
| status | SmartDetectorAlertRule_STATUS Optional |
SmartDetectorAlertRule_Spec
| Property | Description | Type |
|---|---|---|
| actionGroups | The alert rule actions. | ActionGroupsInformation 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 |
| description | The alert rule description. | string Optional |
| detector | The alert rule’s detector. | Detector Required |
| frequency | The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector. | string Required |
| location | The resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SmartDetectorAlertRuleOperatorSpec 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 |
| scopeReferences | The alert rule resources scope. | genruntime.ResourceReference[] Required |
| severity | The alert rule severity. | AlertRuleProperties_Severity Required |
| state | The alert rule state. | AlertRuleProperties_State Required |
| tags | The resource tags. | map[string]string Optional |
| throttling | The alert rule throttling information. | ThrottlingInformation Optional |
SmartDetectorAlertRule_STATUS
| Property | Description | Type |
|---|---|---|
| actionGroups | The alert rule actions. | ActionGroupsInformation_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | The alert rule description. | string Optional |
| detector | The alert rule’s detector. | Detector_STATUS Optional |
| frequency | The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector. | string Optional |
| id | The resource ID. | string Optional |
| location | The resource location. | string Optional |
| name | The resource name. | string Optional |
| scope | The alert rule resources scope. | string[] Optional |
| severity | The alert rule severity. | AlertRuleProperties_Severity_STATUS Optional |
| state | The alert rule state. | AlertRuleProperties_State_STATUS Optional |
| tags | The resource tags. | map[string]string Optional |
| throttling | The alert rule throttling information. | ThrottlingInformation_STATUS Optional |
| type | The resource type. | string Optional |
SmartDetectorAlertRuleList
Generator information: - Generated from: /alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-04-01/SmartDetectorAlertRulesApi.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | SmartDetectorAlertRule[] Optional |
SmartDetectorAlertRule_Spec
Used by: SmartDetectorAlertRule.
| Property | Description | Type |
|---|---|---|
| actionGroups | The alert rule actions. | ActionGroupsInformation 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 |
| description | The alert rule description. | string Optional |
| detector | The alert rule’s detector. | Detector Required |
| frequency | The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector. | string Required |
| location | The resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SmartDetectorAlertRuleOperatorSpec 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 |
| scopeReferences | The alert rule resources scope. | genruntime.ResourceReference[] Required |
| severity | The alert rule severity. | AlertRuleProperties_Severity Required |
| state | The alert rule state. | AlertRuleProperties_State Required |
| tags | The resource tags. | map[string]string Optional |
| throttling | The alert rule throttling information. | ThrottlingInformation Optional |
SmartDetectorAlertRule_STATUS
Used by: SmartDetectorAlertRule.
| Property | Description | Type |
|---|---|---|
| actionGroups | The alert rule actions. | ActionGroupsInformation_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | The alert rule description. | string Optional |
| detector | The alert rule’s detector. | Detector_STATUS Optional |
| frequency | The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector. | string Optional |
| id | The resource ID. | string Optional |
| location | The resource location. | string Optional |
| name | The resource name. | string Optional |
| scope | The alert rule resources scope. | string[] Optional |
| severity | The alert rule severity. | AlertRuleProperties_Severity_STATUS Optional |
| state | The alert rule state. | AlertRuleProperties_State_STATUS Optional |
| tags | The resource tags. | map[string]string Optional |
| throttling | The alert rule throttling information. | ThrottlingInformation_STATUS Optional |
| type | The resource type. | string Optional |
ActionGroupsInformation
The Action Groups information, used by the alert rule.
Used by: SmartDetectorAlertRule_Spec.
| Property | Description | Type |
|---|---|---|
| customEmailSubject | An optional custom email subject to use in email notifications. | string Optional |
| customWebhookPayload | An optional custom web-hook payload to use in web-hook notifications. | string Optional |
| groupReferences | The Action Group resource IDs. | genruntime.ResourceReference[] Required |
ActionGroupsInformation_STATUS
The Action Groups information, used by the alert rule.
Used by: SmartDetectorAlertRule_STATUS.
| Property | Description | Type |
|---|---|---|
| customEmailSubject | An optional custom email subject to use in email notifications. | string Optional |
| customWebhookPayload | An optional custom web-hook payload to use in web-hook notifications. | string Optional |
| groupIds | The Action Group resource IDs. | string[] Optional |
AlertRuleProperties_Severity
Used by: SmartDetectorAlertRule_Spec.
| Value | Description |
|---|---|
| “Sev0” | |
| “Sev1” | |
| “Sev2” | |
| “Sev3” | |
| “Sev4” |
AlertRuleProperties_Severity_STATUS
Used by: SmartDetectorAlertRule_STATUS.
| Value | Description |
|---|---|
| “Sev0” | |
| “Sev1” | |
| “Sev2” | |
| “Sev3” | |
| “Sev4” |
AlertRuleProperties_State
Used by: SmartDetectorAlertRule_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
AlertRuleProperties_State_STATUS
Used by: SmartDetectorAlertRule_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
Detector
The detector information. By default this is not populated, unless it’s specified in expandDetector
Used by: SmartDetectorAlertRule_Spec.
| Property | Description | Type |
|---|---|---|
| id | The detector id. | string Required |
| parameters | The detector’s parameters.' | map[string]v1.JSON Optional |
Detector_STATUS
The detector information. By default this is not populated, unless it’s specified in expandDetector
Used by: SmartDetectorAlertRule_STATUS.
| Property | Description | Type |
|---|---|---|
| description | The Smart Detector description. | string Optional |
| id | The detector id. | string Optional |
| imagePaths | The Smart Detector image path. By default this is not populated, unless it’s specified in expandDetector | string[] Optional |
| name | The Smart Detector name. | string Optional |
| parameterDefinitions | The Smart Detector parameters definitions.' | DetectorParameterDefinition_STATUS[] Optional |
| parameters | The detector’s parameters.' | map[string]v1.JSON Optional |
| supportedCadences | The Smart Detector supported cadences. | int[] Optional |
| supportedResourceTypes | The Smart Detector supported resource types. | string[] Optional |
SmartDetectorAlertRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: SmartDetectorAlertRule_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 |
ThrottlingInformation
Optional throttling information for the alert rule.
Used by: SmartDetectorAlertRule_Spec.
| Property | Description | Type |
|---|---|---|
| duration | The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes | string Optional |
ThrottlingInformation_STATUS
Optional throttling information for the alert rule.
Used by: SmartDetectorAlertRule_STATUS.
| Property | Description | Type |
|---|---|---|
| duration | The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes | string Optional |
DetectorParameterDefinition_STATUS
The detector parameter definition.
Used by: Detector_STATUS.
| Property | Description | Type |
|---|---|---|
| description | The detector parameter description. | string Optional |
| displayName | The detector parameter display name. | string Optional |
| isMandatory | A value indicating whether this detector parameter is mandatory. | bool Optional |
| name | The detector parameter name. | string Optional |
| type | The detector parameter type. | DetectorParameterDefinition_Type_STATUS Optional |
DetectorParameterDefinition_Type_STATUS
Used by: DetectorParameterDefinition_STATUS.
| Value | Description |
|---|---|
| “Boolean” | |
| “DateTime” | |
| “Double” | |
| “Integer” | |
| “String” |