alertsmanagement.azure.com/v1api20210401

Package v1api20210401 contains API Schema definitions for the alertsmanagement v1api20210401 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-04-01"

ActionGroupsInformation

(Appears on:SmartDetectorAlertRule_Spec)

The Action Groups information, used by the alert rule.

Field	Description
`customEmailSubject` string	CustomEmailSubject: An optional custom email subject to use in email notifications.
`customWebhookPayload` string	CustomWebhookPayload: An optional custom web-hook payload to use in web-hook notifications.
`groupReferences` []genruntime.ResourceReference	GroupReferences: The Action Group resource IDs.

ActionGroupsInformation_STATUS

(Appears on:SmartDetectorAlertRule_STATUS)

The Action Groups information, used by the alert rule.

Field	Description
`customEmailSubject` string	CustomEmailSubject: An optional custom email subject to use in email notifications.
`customWebhookPayload` string	CustomWebhookPayload: An optional custom web-hook payload to use in web-hook notifications.
`groupIds` []string	GroupIds: The Action Group resource IDs.

AlertRuleProperties_Severity (`string` alias)

(Appears on:SmartDetectorAlertRule_Spec)

Value	Description
"Sev0"
"Sev1"
"Sev2"
"Sev3"
"Sev4"

AlertRuleProperties_Severity_STATUS (`string` alias)

(Appears on:SmartDetectorAlertRule_STATUS)

Value	Description
"Sev0"
"Sev1"
"Sev2"
"Sev3"
"Sev4"

AlertRuleProperties_State (`string` alias)

(Appears on:SmartDetectorAlertRule_Spec)

Value	Description
"Disabled"
"Enabled"

AlertRuleProperties_State_STATUS (`string` alias)

(Appears on:SmartDetectorAlertRule_STATUS)

Value	Description
"Disabled"
"Enabled"

Detector

(Appears on:SmartDetectorAlertRule_Spec)

The detector information. By default this is not populated, unless it’s specified in expandDetector

Field	Description
`id` string	Id: The detector id.
`parameters` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Parameters: The detector’s parameters.’

DetectorParameterDefinition_STATUS

(Appears on:Detector_STATUS)

The detector parameter definition.

Field	Description
`description` string	Description: The detector parameter description.
`displayName` string	DisplayName: The detector parameter display name.
`isMandatory` bool	IsMandatory: A value indicating whether this detector parameter is mandatory.
`name` string	Name: The detector parameter name.
`type` DetectorParameterDefinition_Type_STATUS	Type: The detector parameter type.

DetectorParameterDefinition_Type_STATUS (`string` alias)

(Appears on:DetectorParameterDefinition_STATUS)

Value	Description
"Boolean"
"DateTime"
"Double"
"Integer"
"String"

Detector_STATUS

(Appears on:SmartDetectorAlertRule_STATUS)

The detector information. By default this is not populated, unless it’s specified in expandDetector

Field	Description
`description` string	Description: The Smart Detector description.
`id` string	Id: The detector id.
`imagePaths` []string	ImagePaths: The Smart Detector image path. By default this is not populated, unless it’s specified in expandDetector
`name` string	Name: The Smart Detector name.
`parameterDefinitions` []DetectorParameterDefinition_STATUS	ParameterDefinitions: The Smart Detector parameters definitions.’
`parameters` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Parameters: The detector’s parameters.’
`supportedCadences` []int	SupportedCadences: The Smart Detector supported cadences.
`supportedResourceTypes` []string	SupportedResourceTypes: The Smart Detector supported resource types.

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}

Field Description

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

spec
SmartDetectorAlertRule_Spec

`actionGroups` ActionGroupsInformation	ActionGroups: The alert rule actions.
`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.
`description` string	Description: The alert rule description.
`detector` Detector	Detector: The alert rule’s detector.
`frequency` string	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.
`location` string	Location: The resource location.
`operatorSpec` SmartDetectorAlertRuleOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`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
`scopeReferences` []genruntime.ResourceReference	ScopeReferences: The alert rule resources scope.
`severity` AlertRuleProperties_Severity	Severity: The alert rule severity.
`state` AlertRuleProperties_State	State: The alert rule state.
`tags` map[string]string	Tags: The resource tags.
`throttling` ThrottlingInformation	Throttling: The alert rule throttling information.

status
SmartDetectorAlertRule_STATUS

SmartDetectorAlertRuleOperatorSpec

(Appears on:SmartDetectorAlertRule_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).

SmartDetectorAlertRule_STATUS

(Appears on:SmartDetectorAlertRule)

Field	Description
`actionGroups` ActionGroupsInformation_STATUS	ActionGroups: The alert rule actions.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`description` string	Description: The alert rule description.
`detector` Detector_STATUS	Detector: The alert rule’s detector.
`frequency` string	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.
`id` string	Id: The resource ID.
`location` string	Location: The resource location.
`name` string	Name: The resource name.
`scope` []string	Scope: The alert rule resources scope.
`severity` AlertRuleProperties_Severity_STATUS	Severity: The alert rule severity.
`state` AlertRuleProperties_State_STATUS	State: The alert rule state.
`tags` map[string]string	Tags: The resource tags.
`throttling` ThrottlingInformation_STATUS	Throttling: The alert rule throttling information.
`type` string	Type: The resource type.

SmartDetectorAlertRule_Spec

(Appears on:SmartDetectorAlertRule)

Field	Description
`actionGroups` ActionGroupsInformation	ActionGroups: The alert rule actions.
`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.
`description` string	Description: The alert rule description.
`detector` Detector	Detector: The alert rule’s detector.
`frequency` string	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.
`location` string	Location: The resource location.
`operatorSpec` SmartDetectorAlertRuleOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`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
`scopeReferences` []genruntime.ResourceReference	ScopeReferences: The alert rule resources scope.
`severity` AlertRuleProperties_Severity	Severity: The alert rule severity.
`state` AlertRuleProperties_State	State: The alert rule state.
`tags` map[string]string	Tags: The resource tags.
`throttling` ThrottlingInformation	Throttling: The alert rule throttling information.

ThrottlingInformation

(Appears on:SmartDetectorAlertRule_Spec)

Optional throttling information for the alert rule.

Field	Description
`duration` string	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

ThrottlingInformation_STATUS

(Appears on:SmartDetectorAlertRule_STATUS)

Optional throttling information for the alert rule.

Field	Description
`duration` string	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

alertsmanagement.azure.com/v1api20210401