const (
// DefaultBaseURI is the default URI used for the service Alertsmanagement
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
ActionGroup action rule with action group configuration
type ActionGroup struct {
// ActionGroupID - Action group to trigger if action rule matches
ActionGroupID *string `json:"actionGroupId,omitempty"`
// Scope - scope on which action rule will apply
Scope *Scope `json:"scope,omitempty"`
// Conditions - conditions on which alerts will be filtered
Conditions *Conditions `json:"conditions,omitempty"`
// Description - Description of action rule
Description *string `json:"description,omitempty"`
// CreatedAt - READ-ONLY; Creation time of action rule. Date-Time in ISO-8601 format.
CreatedAt *date.Time `json:"createdAt,omitempty"`
// LastModifiedAt - READ-ONLY; Last updated time of action rule. Date-Time in ISO-8601 format.
LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
// CreatedBy - READ-ONLY; Created by user name.
CreatedBy *string `json:"createdBy,omitempty"`
// LastModifiedBy - READ-ONLY; Last modified by user name.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// Status - Indicates if the given action rule is enabled or disabled. Possible values include: 'Enabled', 'Disabled'
Status ActionRuleStatus `json:"status,omitempty"`
// Type - Possible values include: 'TypeActionRuleProperties', 'TypeSuppression', 'TypeActionGroup', 'TypeDiagnostics'
Type Type `json:"type,omitempty"`
}
func (ag ActionGroup) AsActionGroup() (*ActionGroup, bool)
AsActionGroup is the BasicActionRuleProperties implementation for ActionGroup.
func (ag ActionGroup) AsActionRuleProperties() (*ActionRuleProperties, bool)
AsActionRuleProperties is the BasicActionRuleProperties implementation for ActionGroup.
func (ag ActionGroup) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)
AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for ActionGroup.
func (ag ActionGroup) AsDiagnostics() (*Diagnostics, bool)
AsDiagnostics is the BasicActionRuleProperties implementation for ActionGroup.
func (ag ActionGroup) AsSuppression() (*Suppression, bool)
AsSuppression is the BasicActionRuleProperties implementation for ActionGroup.
func (ag ActionGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ActionGroup.
ActionGroupsInformation the Action Groups information, used by the alert rule.
type ActionGroupsInformation struct {
// CustomEmailSubject - An optional custom email subject to use in email notifications.
CustomEmailSubject *string `json:"customEmailSubject,omitempty"`
// CustomWebhookPayload - An optional custom web-hook payload to use in web-hook notifications.
CustomWebhookPayload *string `json:"customWebhookPayload,omitempty"`
// GroupIds - The Action Group resource IDs.
GroupIds *[]string `json:"groupIds,omitempty"`
}
ActionRule action rule object containing target scope, conditions and suppression logic
type ActionRule struct {
autorest.Response `json:"-"`
// Properties - action rule properties
Properties BasicActionRuleProperties `json:"properties,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (ar ActionRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ActionRule.
func (ar *ActionRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ActionRule struct.
ActionRuleProperties action rule properties defining scope, conditions, suppression logic for action rule
type ActionRuleProperties struct {
// Scope - scope on which action rule will apply
Scope *Scope `json:"scope,omitempty"`
// Conditions - conditions on which alerts will be filtered
Conditions *Conditions `json:"conditions,omitempty"`
// Description - Description of action rule
Description *string `json:"description,omitempty"`
// CreatedAt - READ-ONLY; Creation time of action rule. Date-Time in ISO-8601 format.
CreatedAt *date.Time `json:"createdAt,omitempty"`
// LastModifiedAt - READ-ONLY; Last updated time of action rule. Date-Time in ISO-8601 format.
LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
// CreatedBy - READ-ONLY; Created by user name.
CreatedBy *string `json:"createdBy,omitempty"`
// LastModifiedBy - READ-ONLY; Last modified by user name.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// Status - Indicates if the given action rule is enabled or disabled. Possible values include: 'Enabled', 'Disabled'
Status ActionRuleStatus `json:"status,omitempty"`
// Type - Possible values include: 'TypeActionRuleProperties', 'TypeSuppression', 'TypeActionGroup', 'TypeDiagnostics'
Type Type `json:"type,omitempty"`
}
func (arp ActionRuleProperties) AsActionGroup() (*ActionGroup, bool)
AsActionGroup is the BasicActionRuleProperties implementation for ActionRuleProperties.
func (arp ActionRuleProperties) AsActionRuleProperties() (*ActionRuleProperties, bool)
AsActionRuleProperties is the BasicActionRuleProperties implementation for ActionRuleProperties.
func (arp ActionRuleProperties) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)
AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for ActionRuleProperties.
func (arp ActionRuleProperties) AsDiagnostics() (*Diagnostics, bool)
AsDiagnostics is the BasicActionRuleProperties implementation for ActionRuleProperties.
func (arp ActionRuleProperties) AsSuppression() (*Suppression, bool)
AsSuppression is the BasicActionRuleProperties implementation for ActionRuleProperties.
func (arp ActionRuleProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ActionRuleProperties.
ActionRuleStatus enumerates the values for action rule status.
type ActionRuleStatus string
const (
// Disabled ...
Disabled ActionRuleStatus = "Disabled"
// Enabled ...
Enabled ActionRuleStatus = "Enabled"
)
func PossibleActionRuleStatusValues() []ActionRuleStatus
PossibleActionRuleStatusValues returns an array of possible values for the ActionRuleStatus const type.
ActionRulesClient is the alertsManagement Client
type ActionRulesClient struct {
BaseClient
}
func NewActionRulesClient(subscriptionID string) ActionRulesClient
NewActionRulesClient creates an instance of the ActionRulesClient client.
func NewActionRulesClientWithBaseURI(baseURI string, subscriptionID string) ActionRulesClient
NewActionRulesClientWithBaseURI creates an instance of the ActionRulesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ActionRulesClient) CreateUpdate(ctx context.Context, resourceGroupName string, actionRuleName string, actionRule ActionRule) (result ActionRule, err error)
CreateUpdate creates/Updates a specific action rule Parameters: resourceGroupName - resource group name where the resource is created. actionRuleName - the name of action rule that needs to be created/updated actionRule - action rule to be created/updated
func (client ActionRulesClient) CreateUpdatePreparer(ctx context.Context, resourceGroupName string, actionRuleName string, actionRule ActionRule) (*http.Request, error)
CreateUpdatePreparer prepares the CreateUpdate request.
func (client ActionRulesClient) CreateUpdateResponder(resp *http.Response) (result ActionRule, err error)
CreateUpdateResponder handles the response to the CreateUpdate request. The method always closes the http.Response Body.
func (client ActionRulesClient) CreateUpdateSender(req *http.Request) (*http.Response, error)
CreateUpdateSender sends the CreateUpdate request. The method will close the http.Response Body if it receives an error.
func (client ActionRulesClient) Delete(ctx context.Context, resourceGroupName string, actionRuleName string) (result Bool, err error)
Delete deletes a given action rule Parameters: resourceGroupName - resource group name where the resource is created. actionRuleName - the name that needs to be deleted
func (client ActionRulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, actionRuleName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ActionRulesClient) DeleteResponder(resp *http.Response) (result Bool, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ActionRulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ActionRulesClient) GetByName(ctx context.Context, resourceGroupName string, actionRuleName string) (result ActionRule, err error)
GetByName get a specific action rule Parameters: resourceGroupName - resource group name where the resource is created. actionRuleName - the name of action rule that needs to be fetched
func (client ActionRulesClient) GetByNamePreparer(ctx context.Context, resourceGroupName string, actionRuleName string) (*http.Request, error)
GetByNamePreparer prepares the GetByName request.
func (client ActionRulesClient) GetByNameResponder(resp *http.Response) (result ActionRule, err error)
GetByNameResponder handles the response to the GetByName request. The method always closes the http.Response Body.
func (client ActionRulesClient) GetByNameSender(req *http.Request) (*http.Response, error)
GetByNameSender sends the GetByName request. The method will close the http.Response Body if it receives an error.
func (client ActionRulesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, targetResourceGroup string, targetResourceType string, targetResource string, severity Severity, monitorService MonitorService, impactedScope string, description string, alertRuleID string, actionGroup string, name string) (result ActionRulesListPage, err error)
ListByResourceGroup list all action rules of the subscription, created in given resource group and given input filters Parameters: resourceGroupName - resource group name where the resource is created. targetResourceGroup - filter by target resource group name. Default value is select all. targetResourceType - filter by target resource type. Default value is select all. targetResource - filter by target resource( which is full ARM ID) Default value is select all. severity - filter by severity. Default value is select all. monitorService - filter by monitor service which generates the alert instance. Default value is select all. impactedScope - filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope. description - filter by alert rule description alertRuleID - filter by alert rule id actionGroup - filter by action group configured as part of action rule name - filter by action rule name
func (client ActionRulesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, targetResourceGroup string, targetResourceType string, targetResource string, severity Severity, monitorService MonitorService, impactedScope string, description string, alertRuleID string, actionGroup string, name string) (result ActionRulesListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ActionRulesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, targetResourceGroup string, targetResourceType string, targetResource string, severity Severity, monitorService MonitorService, impactedScope string, description string, alertRuleID string, actionGroup string, name string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ActionRulesClient) ListByResourceGroupResponder(resp *http.Response) (result ActionRulesList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ActionRulesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ActionRulesClient) ListBySubscription(ctx context.Context, targetResourceGroup string, targetResourceType string, targetResource string, severity Severity, monitorService MonitorService, impactedScope string, description string, alertRuleID string, actionGroup string, name string) (result ActionRulesListPage, err error)
ListBySubscription list all action rules of the subscription and given input filters Parameters: targetResourceGroup - filter by target resource group name. Default value is select all. targetResourceType - filter by target resource type. Default value is select all. targetResource - filter by target resource( which is full ARM ID) Default value is select all. severity - filter by severity. Default value is select all. monitorService - filter by monitor service which generates the alert instance. Default value is select all. impactedScope - filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope. description - filter by alert rule description alertRuleID - filter by alert rule id actionGroup - filter by action group configured as part of action rule name - filter by action rule name
func (client ActionRulesClient) ListBySubscriptionComplete(ctx context.Context, targetResourceGroup string, targetResourceType string, targetResource string, severity Severity, monitorService MonitorService, impactedScope string, description string, alertRuleID string, actionGroup string, name string) (result ActionRulesListIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client ActionRulesClient) ListBySubscriptionPreparer(ctx context.Context, targetResourceGroup string, targetResourceType string, targetResource string, severity Severity, monitorService MonitorService, impactedScope string, description string, alertRuleID string, actionGroup string, name string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client ActionRulesClient) ListBySubscriptionResponder(resp *http.Response) (result ActionRulesList, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client ActionRulesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client ActionRulesClient) Update(ctx context.Context, resourceGroupName string, actionRuleName string, actionRulePatch PatchObject) (result ActionRule, err error)
Update update enabled flag and/or tags for the given action rule Parameters: resourceGroupName - resource group name where the resource is created. actionRuleName - the name that needs to be updated actionRulePatch - parameters supplied to the operation.
func (client ActionRulesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, actionRuleName string, actionRulePatch PatchObject) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ActionRulesClient) UpdateResponder(resp *http.Response) (result ActionRule, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ActionRulesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ActionRulesList list of action rules
type ActionRulesList struct {
autorest.Response `json:"-"`
// NextLink - URL to fetch the next set of action rules
NextLink *string `json:"nextLink,omitempty"`
// Value - List of action rules
Value *[]ActionRule `json:"value,omitempty"`
}
func (arl ActionRulesList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ActionRulesListIterator provides access to a complete listing of ActionRule values.
type ActionRulesListIterator struct {
// contains filtered or unexported fields
}
func NewActionRulesListIterator(page ActionRulesListPage) ActionRulesListIterator
Creates a new instance of the ActionRulesListIterator type.
func (iter *ActionRulesListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ActionRulesListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ActionRulesListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ActionRulesListIterator) Response() ActionRulesList
Response returns the raw server response from the last page request.
func (iter ActionRulesListIterator) Value() ActionRule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ActionRulesListPage contains a page of ActionRule values.
type ActionRulesListPage struct {
// contains filtered or unexported fields
}
func NewActionRulesListPage(cur ActionRulesList, getNextPage func(context.Context, ActionRulesList) (ActionRulesList, error)) ActionRulesListPage
Creates a new instance of the ActionRulesListPage type.
func (page *ActionRulesListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ActionRulesListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ActionRulesListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ActionRulesListPage) Response() ActionRulesList
Response returns the raw server response from the last page request.
func (page ActionRulesListPage) Values() []ActionRule
Values returns the slice of values for the current page or nil if there are no values.
Alert an alert created in alert management service.
type Alert struct {
autorest.Response `json:"-"`
Properties *AlertProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (a Alert) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Alert.
AlertModification alert Modification details
type AlertModification struct {
autorest.Response `json:"-"`
Properties *AlertModificationProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (am AlertModification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertModification.
AlertModificationEvent enumerates the values for alert modification event.
type AlertModificationEvent string
const (
// ActionRuleSuppressed ...
ActionRuleSuppressed AlertModificationEvent = "ActionRuleSuppressed"
// ActionRuleTriggered ...
ActionRuleTriggered AlertModificationEvent = "ActionRuleTriggered"
// ActionsFailed ...
ActionsFailed AlertModificationEvent = "ActionsFailed"
// ActionsSuppressed ...
ActionsSuppressed AlertModificationEvent = "ActionsSuppressed"
// ActionsTriggered ...
ActionsTriggered AlertModificationEvent = "ActionsTriggered"
// AlertCreated ...
AlertCreated AlertModificationEvent = "AlertCreated"
// MonitorConditionChange ...
MonitorConditionChange AlertModificationEvent = "MonitorConditionChange"
// SeverityChange ...
SeverityChange AlertModificationEvent = "SeverityChange"
// StateChange ...
StateChange AlertModificationEvent = "StateChange"
)
func PossibleAlertModificationEventValues() []AlertModificationEvent
PossibleAlertModificationEventValues returns an array of possible values for the AlertModificationEvent const type.
AlertModificationItem alert modification item.
type AlertModificationItem struct {
// ModificationEvent - Reason for the modification. Possible values include: 'AlertCreated', 'StateChange', 'MonitorConditionChange', 'SeverityChange', 'ActionRuleTriggered', 'ActionRuleSuppressed', 'ActionsTriggered', 'ActionsSuppressed', 'ActionsFailed'
ModificationEvent AlertModificationEvent `json:"modificationEvent,omitempty"`
// OldValue - Old value
OldValue *string `json:"oldValue,omitempty"`
// NewValue - New value
NewValue *string `json:"newValue,omitempty"`
// ModifiedAt - Modified date and time
ModifiedAt *string `json:"modifiedAt,omitempty"`
// ModifiedBy - Modified user details (Principal client name)
ModifiedBy *string `json:"modifiedBy,omitempty"`
// Comments - Modification comments
Comments *string `json:"comments,omitempty"`
// Description - Description of the modification
Description *string `json:"description,omitempty"`
}
AlertModificationProperties properties of the alert modification item.
type AlertModificationProperties struct {
// AlertID - READ-ONLY; Unique Id of the alert for which the history is being retrieved
AlertID *string `json:"alertId,omitempty"`
// Modifications - Modification details
Modifications *[]AlertModificationItem `json:"modifications,omitempty"`
}
func (amp AlertModificationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertModificationProperties.
AlertProperties alert property bag
type AlertProperties struct {
Essentials *Essentials `json:"essentials,omitempty"`
Context interface{} `json:"context,omitempty"`
EgressConfig interface{} `json:"egressConfig,omitempty"`
}
AlertRule the alert rule information
type AlertRule struct {
autorest.Response `json:"-"`
// AlertRuleProperties - The properties of the alert rule.
*AlertRuleProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}
func (ar AlertRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertRule.
func (ar *AlertRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AlertRule struct.
AlertRulePatchObject the alert rule patch information
type AlertRulePatchObject struct {
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
// AlertRulePatchProperties - The properties of the alert rule.
*AlertRulePatchProperties `json:"properties,omitempty"`
}
func (arpo AlertRulePatchObject) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertRulePatchObject.
func (arpo *AlertRulePatchObject) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AlertRulePatchObject struct.
AlertRulePatchProperties the alert rule properties.
type AlertRulePatchProperties struct {
// Description - The alert rule description.
Description *string `json:"description,omitempty"`
// State - The alert rule state. Possible values include: 'AlertRuleStateEnabled', 'AlertRuleStateDisabled'
State AlertRuleState `json:"state,omitempty"`
// Severity - The alert rule severity. Possible values include: 'Sev0', 'Sev1', 'Sev2', 'Sev3', 'Sev4'
Severity Severity `json:"severity,omitempty"`
// Frequency - The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes.
Frequency *string `json:"frequency,omitempty"`
// ActionGroups - The alert rule actions.
ActionGroups *ActionGroupsInformation `json:"actionGroups,omitempty"`
// Throttling - The alert rule throttling information.
Throttling *ThrottlingInformation `json:"throttling,omitempty"`
}
AlertRuleProperties the alert rule properties.
type AlertRuleProperties struct {
// Description - The alert rule description.
Description *string `json:"description,omitempty"`
// State - The alert rule state. Possible values include: 'AlertRuleStateEnabled', 'AlertRuleStateDisabled'
State AlertRuleState `json:"state,omitempty"`
// Severity - The alert rule severity. Possible values include: 'Sev0', 'Sev1', 'Sev2', 'Sev3', 'Sev4'
Severity Severity `json:"severity,omitempty"`
// Frequency - The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes.
Frequency *string `json:"frequency,omitempty"`
// Detector - The alert rule's detector.
Detector *Detector `json:"detector,omitempty"`
// Scope - The alert rule resources scope.
Scope *[]string `json:"scope,omitempty"`
// ActionGroups - The alert rule actions.
ActionGroups *ActionGroupsInformation `json:"actionGroups,omitempty"`
// Throttling - The alert rule throttling information.
Throttling *ThrottlingInformation `json:"throttling,omitempty"`
}
AlertRuleState enumerates the values for alert rule state.
type AlertRuleState string
const (
// AlertRuleStateDisabled ...
AlertRuleStateDisabled AlertRuleState = "Disabled"
// AlertRuleStateEnabled ...
AlertRuleStateEnabled AlertRuleState = "Enabled"
)
func PossibleAlertRuleStateValues() []AlertRuleState
PossibleAlertRuleStateValues returns an array of possible values for the AlertRuleState const type.
AlertRulesList list of Smart Detector alert rules.
type AlertRulesList struct {
autorest.Response `json:"-"`
// Value - List of Smart Detector alert rules.
Value *[]AlertRule `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (arl AlertRulesList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AlertRulesListIterator provides access to a complete listing of AlertRule values.
type AlertRulesListIterator struct {
// contains filtered or unexported fields
}
func NewAlertRulesListIterator(page AlertRulesListPage) AlertRulesListIterator
Creates a new instance of the AlertRulesListIterator type.
func (iter *AlertRulesListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AlertRulesListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AlertRulesListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AlertRulesListIterator) Response() AlertRulesList
Response returns the raw server response from the last page request.
func (iter AlertRulesListIterator) Value() AlertRule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
AlertRulesListPage contains a page of AlertRule values.
type AlertRulesListPage struct {
// contains filtered or unexported fields
}
func NewAlertRulesListPage(cur AlertRulesList, getNextPage func(context.Context, AlertRulesList) (AlertRulesList, error)) AlertRulesListPage
Creates a new instance of the AlertRulesListPage type.
func (page *AlertRulesListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AlertRulesListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AlertRulesListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AlertRulesListPage) Response() AlertRulesList
Response returns the raw server response from the last page request.
func (page AlertRulesListPage) Values() []AlertRule
Values returns the slice of values for the current page or nil if there are no values.
AlertState enumerates the values for alert state.
type AlertState string
const (
// AlertStateAcknowledged ...
AlertStateAcknowledged AlertState = "Acknowledged"
// AlertStateClosed ...
AlertStateClosed AlertState = "Closed"
// AlertStateNew ...
AlertStateNew AlertState = "New"
)
func PossibleAlertStateValues() []AlertState
PossibleAlertStateValues returns an array of possible values for the AlertState const type.
AlertsClient is the alertsManagement Client
type AlertsClient struct {
BaseClient
}
func NewAlertsClient(subscriptionID string) AlertsClient
NewAlertsClient creates an instance of the AlertsClient client.
func NewAlertsClientWithBaseURI(baseURI string, subscriptionID string) AlertsClient
NewAlertsClientWithBaseURI creates an instance of the AlertsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AlertsClient) ChangeState(ctx context.Context, alertID string, newState AlertState) (result Alert, err error)
ChangeState change the state of an alert. Parameters: alertID - unique ID of an alert instance. newState - new state of the alert.
func (client AlertsClient) ChangeStatePreparer(ctx context.Context, alertID string, newState AlertState) (*http.Request, error)
ChangeStatePreparer prepares the ChangeState request.
func (client AlertsClient) ChangeStateResponder(resp *http.Response) (result Alert, err error)
ChangeStateResponder handles the response to the ChangeState request. The method always closes the http.Response Body.
func (client AlertsClient) ChangeStateSender(req *http.Request) (*http.Response, error)
ChangeStateSender sends the ChangeState request. The method will close the http.Response Body if it receives an error.
func (client AlertsClient) GetAll(ctx context.Context, targetResource string, targetResourceType string, targetResourceGroup string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, alertState AlertState, alertRule string, smartGroupID string, includeContext *bool, includeEgressConfig *bool, pageCount *int32, sortBy AlertsSortByFields, sortOrder string, selectParameter string, timeRange TimeRange, customTimeRange string) (result AlertsListPage, err error)
GetAll list all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime. Parameters: targetResource - filter by target resource( which is full ARM ID) Default value is select all. targetResourceType - filter by target resource type. Default value is select all. targetResourceGroup - filter by target resource group name. Default value is select all. monitorService - filter by monitor service which generates the alert instance. Default value is select all. monitorCondition - filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. severity - filter by severity. Default value is select all. alertState - filter by state of the alert instance. Default value is to select all. alertRule - filter by specific alert rule. Default value is to select all. smartGroupID - filter the alerts list by the Smart Group Id. Default value is none. includeContext - include context which has contextual data specific to the monitor service. Default value is false' includeEgressConfig - include egress config which would be used for displaying the content in portal. Default value is 'false'. pageCount - determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25. sortBy - sort the query results by input field, Default value is 'lastModifiedDateTime'. sortOrder - sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others. selectParameter - this filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. timeRange - filter by time range by below listed values. Default value is 1 day. customTimeRange - filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none.
func (client AlertsClient) GetAllComplete(ctx context.Context, targetResource string, targetResourceType string, targetResourceGroup string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, alertState AlertState, alertRule string, smartGroupID string, includeContext *bool, includeEgressConfig *bool, pageCount *int32, sortBy AlertsSortByFields, sortOrder string, selectParameter string, timeRange TimeRange, customTimeRange string) (result AlertsListIterator, err error)
GetAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client AlertsClient) GetAllPreparer(ctx context.Context, targetResource string, targetResourceType string, targetResourceGroup string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, alertState AlertState, alertRule string, smartGroupID string, includeContext *bool, includeEgressConfig *bool, pageCount *int32, sortBy AlertsSortByFields, sortOrder string, selectParameter string, timeRange TimeRange, customTimeRange string) (*http.Request, error)
GetAllPreparer prepares the GetAll request.
func (client AlertsClient) GetAllResponder(resp *http.Response) (result AlertsList, err error)
GetAllResponder handles the response to the GetAll request. The method always closes the http.Response Body.
func (client AlertsClient) GetAllSender(req *http.Request) (*http.Response, error)
GetAllSender sends the GetAll request. The method will close the http.Response Body if it receives an error.
func (client AlertsClient) GetByID(ctx context.Context, alertID string) (result Alert, err error)
GetByID get information related to a specific alert Parameters: alertID - unique ID of an alert instance.
func (client AlertsClient) GetByIDPreparer(ctx context.Context, alertID string) (*http.Request, error)
GetByIDPreparer prepares the GetByID request.
func (client AlertsClient) GetByIDResponder(resp *http.Response) (result Alert, err error)
GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.
func (client AlertsClient) GetByIDSender(req *http.Request) (*http.Response, error)
GetByIDSender sends the GetByID request. The method will close the http.Response Body if it receives an error.
func (client AlertsClient) GetHistory(ctx context.Context, alertID string) (result AlertModification, err error)
GetHistory get the history of an alert, which captures any monitor condition changes (Fired/Resolved) and alert state changes (New/Acknowledged/Closed). Parameters: alertID - unique ID of an alert instance.
func (client AlertsClient) GetHistoryPreparer(ctx context.Context, alertID string) (*http.Request, error)
GetHistoryPreparer prepares the GetHistory request.
func (client AlertsClient) GetHistoryResponder(resp *http.Response) (result AlertModification, err error)
GetHistoryResponder handles the response to the GetHistory request. The method always closes the http.Response Body.
func (client AlertsClient) GetHistorySender(req *http.Request) (*http.Response, error)
GetHistorySender sends the GetHistory request. The method will close the http.Response Body if it receives an error.
func (client AlertsClient) GetSummary(ctx context.Context, groupby AlertsSummaryGroupByFields, includeSmartGroupsCount *bool, targetResource string, targetResourceType string, targetResourceGroup string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, alertState AlertState, alertRule string, timeRange TimeRange, customTimeRange string) (result AlertsSummary, err error)
GetSummary get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity). Parameters: groupby - this parameter allows the result set to be grouped by input fields (Maximum 2 comma separated fields supported). For example, groupby=severity or groupby=severity,alertstate. includeSmartGroupsCount - include count of the SmartGroups as part of the summary. Default value is 'false'. targetResource - filter by target resource( which is full ARM ID) Default value is select all. targetResourceType - filter by target resource type. Default value is select all. targetResourceGroup - filter by target resource group name. Default value is select all. monitorService - filter by monitor service which generates the alert instance. Default value is select all. monitorCondition - filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. severity - filter by severity. Default value is select all. alertState - filter by state of the alert instance. Default value is to select all. alertRule - filter by specific alert rule. Default value is to select all. timeRange - filter by time range by below listed values. Default value is 1 day. customTimeRange - filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none.
func (client AlertsClient) GetSummaryPreparer(ctx context.Context, groupby AlertsSummaryGroupByFields, includeSmartGroupsCount *bool, targetResource string, targetResourceType string, targetResourceGroup string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, alertState AlertState, alertRule string, timeRange TimeRange, customTimeRange string) (*http.Request, error)
GetSummaryPreparer prepares the GetSummary request.
func (client AlertsClient) GetSummaryResponder(resp *http.Response) (result AlertsSummary, err error)
GetSummaryResponder handles the response to the GetSummary request. The method always closes the http.Response Body.
func (client AlertsClient) GetSummarySender(req *http.Request) (*http.Response, error)
GetSummarySender sends the GetSummary request. The method will close the http.Response Body if it receives an error.
func (client AlertsClient) MetaData(ctx context.Context) (result AlertsMetaData, err error)
MetaData list alerts meta data information based on value of identifier parameter.
func (client AlertsClient) MetaDataPreparer(ctx context.Context) (*http.Request, error)
MetaDataPreparer prepares the MetaData request.
func (client AlertsClient) MetaDataResponder(resp *http.Response) (result AlertsMetaData, err error)
MetaDataResponder handles the response to the MetaData request. The method always closes the http.Response Body.
func (client AlertsClient) MetaDataSender(req *http.Request) (*http.Response, error)
MetaDataSender sends the MetaData request. The method will close the http.Response Body if it receives an error.
AlertsList list the alerts.
type AlertsList struct {
autorest.Response `json:"-"`
// NextLink - URL to fetch the next set of alerts.
NextLink *string `json:"nextLink,omitempty"`
// Value - List of alerts
Value *[]Alert `json:"value,omitempty"`
}
func (al AlertsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AlertsListIterator provides access to a complete listing of Alert values.
type AlertsListIterator struct {
// contains filtered or unexported fields
}
func NewAlertsListIterator(page AlertsListPage) AlertsListIterator
Creates a new instance of the AlertsListIterator type.
func (iter *AlertsListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AlertsListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AlertsListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AlertsListIterator) Response() AlertsList
Response returns the raw server response from the last page request.
func (iter AlertsListIterator) Value() Alert
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
AlertsListPage contains a page of Alert values.
type AlertsListPage struct {
// contains filtered or unexported fields
}
func NewAlertsListPage(cur AlertsList, getNextPage func(context.Context, AlertsList) (AlertsList, error)) AlertsListPage
Creates a new instance of the AlertsListPage type.
func (page *AlertsListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AlertsListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AlertsListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AlertsListPage) Response() AlertsList
Response returns the raw server response from the last page request.
func (page AlertsListPage) Values() []Alert
Values returns the slice of values for the current page or nil if there are no values.
AlertsMetaData alert meta data information.
type AlertsMetaData struct {
autorest.Response `json:"-"`
Properties BasicAlertsMetaDataProperties `json:"properties,omitempty"`
}
func (amd *AlertsMetaData) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AlertsMetaData struct.
AlertsMetaDataProperties alert meta data property bag
type AlertsMetaDataProperties struct {
// MetadataIdentifier - Possible values include: 'MetadataIdentifierAlertsMetaDataProperties', 'MetadataIdentifierMonitorServiceList'
MetadataIdentifier MetadataIdentifier `json:"metadataIdentifier,omitempty"`
}
func (amdp AlertsMetaDataProperties) AsAlertsMetaDataProperties() (*AlertsMetaDataProperties, bool)
AsAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for AlertsMetaDataProperties.
func (amdp AlertsMetaDataProperties) AsBasicAlertsMetaDataProperties() (BasicAlertsMetaDataProperties, bool)
AsBasicAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for AlertsMetaDataProperties.
func (amdp AlertsMetaDataProperties) AsMonitorServiceList() (*MonitorServiceList, bool)
AsMonitorServiceList is the BasicAlertsMetaDataProperties implementation for AlertsMetaDataProperties.
func (amdp AlertsMetaDataProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertsMetaDataProperties.
AlertsSortByFields enumerates the values for alerts sort by fields.
type AlertsSortByFields string
const (
// AlertsSortByFieldsAlertState ...
AlertsSortByFieldsAlertState AlertsSortByFields = "alertState"
// AlertsSortByFieldsLastModifiedDateTime ...
AlertsSortByFieldsLastModifiedDateTime AlertsSortByFields = "lastModifiedDateTime"
// AlertsSortByFieldsMonitorCondition ...
AlertsSortByFieldsMonitorCondition AlertsSortByFields = "monitorCondition"
// AlertsSortByFieldsName ...
AlertsSortByFieldsName AlertsSortByFields = "name"
// AlertsSortByFieldsSeverity ...
AlertsSortByFieldsSeverity AlertsSortByFields = "severity"
// AlertsSortByFieldsStartDateTime ...
AlertsSortByFieldsStartDateTime AlertsSortByFields = "startDateTime"
// AlertsSortByFieldsTargetResource ...
AlertsSortByFieldsTargetResource AlertsSortByFields = "targetResource"
// AlertsSortByFieldsTargetResourceGroup ...
AlertsSortByFieldsTargetResourceGroup AlertsSortByFields = "targetResourceGroup"
// AlertsSortByFieldsTargetResourceName ...
AlertsSortByFieldsTargetResourceName AlertsSortByFields = "targetResourceName"
// AlertsSortByFieldsTargetResourceType ...
AlertsSortByFieldsTargetResourceType AlertsSortByFields = "targetResourceType"
)
func PossibleAlertsSortByFieldsValues() []AlertsSortByFields
PossibleAlertsSortByFieldsValues returns an array of possible values for the AlertsSortByFields const type.
AlertsSummary summary of alerts based on the input filters and 'groupby' parameters.
type AlertsSummary struct {
autorest.Response `json:"-"`
Properties *AlertsSummaryGroup `json:"properties,omitempty"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (as AlertsSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertsSummary.
AlertsSummaryGroup group the result set.
type AlertsSummaryGroup struct {
// Total - Total count of the result set.
Total *int32 `json:"total,omitempty"`
// SmartGroupsCount - Total count of the smart groups.
SmartGroupsCount *int32 `json:"smartGroupsCount,omitempty"`
// Groupedby - Name of the field aggregated
Groupedby *string `json:"groupedby,omitempty"`
// Values - List of the items
Values *[]AlertsSummaryGroupItem `json:"values,omitempty"`
}
AlertsSummaryGroupByFields enumerates the values for alerts summary group by fields.
type AlertsSummaryGroupByFields string
const (
// AlertsSummaryGroupByFieldsAlertRule ...
AlertsSummaryGroupByFieldsAlertRule AlertsSummaryGroupByFields = "alertRule"
// AlertsSummaryGroupByFieldsAlertState ...
AlertsSummaryGroupByFieldsAlertState AlertsSummaryGroupByFields = "alertState"
// AlertsSummaryGroupByFieldsMonitorCondition ...
AlertsSummaryGroupByFieldsMonitorCondition AlertsSummaryGroupByFields = "monitorCondition"
// AlertsSummaryGroupByFieldsMonitorService ...
AlertsSummaryGroupByFieldsMonitorService AlertsSummaryGroupByFields = "monitorService"
// AlertsSummaryGroupByFieldsSeverity ...
AlertsSummaryGroupByFieldsSeverity AlertsSummaryGroupByFields = "severity"
// AlertsSummaryGroupByFieldsSignalType ...
AlertsSummaryGroupByFieldsSignalType AlertsSummaryGroupByFields = "signalType"
)
func PossibleAlertsSummaryGroupByFieldsValues() []AlertsSummaryGroupByFields
PossibleAlertsSummaryGroupByFieldsValues returns an array of possible values for the AlertsSummaryGroupByFields const type.
AlertsSummaryGroupItem alerts summary group item
type AlertsSummaryGroupItem struct {
// Name - Value of the aggregated field
Name *string `json:"name,omitempty"`
// Count - Count of the aggregated field
Count *int32 `json:"count,omitempty"`
// Groupedby - Name of the field aggregated
Groupedby *string `json:"groupedby,omitempty"`
// Values - List of the items
Values *[]AlertsSummaryGroupItem `json:"values,omitempty"`
}
AzureResource an Azure resource object
type AzureResource struct {
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}
func (ar AzureResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AzureResource.
BaseClient is the base client for Alertsmanagement.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
BasicActionRuleProperties action rule properties defining scope, conditions, suppression logic for action rule
type BasicActionRuleProperties interface {
AsSuppression() (*Suppression, bool)
AsActionGroup() (*ActionGroup, bool)
AsDiagnostics() (*Diagnostics, bool)
AsActionRuleProperties() (*ActionRuleProperties, bool)
}
BasicAlertsMetaDataProperties alert meta data property bag
type BasicAlertsMetaDataProperties interface {
AsMonitorServiceList() (*MonitorServiceList, bool)
AsAlertsMetaDataProperties() (*AlertsMetaDataProperties, bool)
}
Bool ...
type Bool struct {
autorest.Response `json:"-"`
Value *bool `json:"value,omitempty"`
}
Condition condition to trigger an action rule
type Condition struct {
// Operator - operator for a given condition. Possible values include: 'Equals', 'NotEquals', 'Contains', 'DoesNotContain'
Operator Operator `json:"operator,omitempty"`
// Values - list of values to match for a given condition.
Values *[]string `json:"values,omitempty"`
}
Conditions conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation.
type Conditions struct {
// Severity - filter alerts by severity
Severity *Condition `json:"severity,omitempty"`
// MonitorService - filter alerts by monitor service
MonitorService *Condition `json:"monitorService,omitempty"`
// MonitorCondition - filter alerts by monitor condition
MonitorCondition *Condition `json:"monitorCondition,omitempty"`
// TargetResourceType - filter alerts by target resource type
TargetResourceType *Condition `json:"targetResourceType,omitempty"`
// AlertRuleID - filter alerts by alert rule id
AlertRuleID *Condition `json:"alertRuleId,omitempty"`
// Description - filter alerts by alert rule description
Description *Condition `json:"description,omitempty"`
// AlertContext - filter alerts by alert context (payload)
AlertContext *Condition `json:"alertContext,omitempty"`
}
Detector the detector information. By default this is not populated, unless it's specified in expandDetector
type Detector struct {
// ID - The detector id.
ID *string `json:"id,omitempty"`
// Parameters - The detector's parameters.'
Parameters map[string]interface{} `json:"parameters"`
// Name - The Smart Detector name. By default this is not populated, unless it's specified in expandDetector
Name *string `json:"name,omitempty"`
// Description - The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
Description *string `json:"description,omitempty"`
// SupportedResourceTypes - The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector
SupportedResourceTypes *[]string `json:"supportedResourceTypes,omitempty"`
// ImagePaths - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
ImagePaths *[]string `json:"imagePaths,omitempty"`
}
func (d Detector) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Detector.
Diagnostics action rule with diagnostics configuration
type Diagnostics struct {
// Scope - scope on which action rule will apply
Scope *Scope `json:"scope,omitempty"`
// Conditions - conditions on which alerts will be filtered
Conditions *Conditions `json:"conditions,omitempty"`
// Description - Description of action rule
Description *string `json:"description,omitempty"`
// CreatedAt - READ-ONLY; Creation time of action rule. Date-Time in ISO-8601 format.
CreatedAt *date.Time `json:"createdAt,omitempty"`
// LastModifiedAt - READ-ONLY; Last updated time of action rule. Date-Time in ISO-8601 format.
LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
// CreatedBy - READ-ONLY; Created by user name.
CreatedBy *string `json:"createdBy,omitempty"`
// LastModifiedBy - READ-ONLY; Last modified by user name.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// Status - Indicates if the given action rule is enabled or disabled. Possible values include: 'Enabled', 'Disabled'
Status ActionRuleStatus `json:"status,omitempty"`
// Type - Possible values include: 'TypeActionRuleProperties', 'TypeSuppression', 'TypeActionGroup', 'TypeDiagnostics'
Type Type `json:"type,omitempty"`
}
func (d Diagnostics) AsActionGroup() (*ActionGroup, bool)
AsActionGroup is the BasicActionRuleProperties implementation for Diagnostics.
func (d Diagnostics) AsActionRuleProperties() (*ActionRuleProperties, bool)
AsActionRuleProperties is the BasicActionRuleProperties implementation for Diagnostics.
func (d Diagnostics) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)
AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for Diagnostics.
func (d Diagnostics) AsDiagnostics() (*Diagnostics, bool)
AsDiagnostics is the BasicActionRuleProperties implementation for Diagnostics.
func (d Diagnostics) AsSuppression() (*Suppression, bool)
AsSuppression is the BasicActionRuleProperties implementation for Diagnostics.
func (d Diagnostics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Diagnostics.
ErrorResponse an error response from the service.
type ErrorResponse struct {
Error *ErrorResponseBody `json:"error,omitempty"`
}
ErrorResponseBody details of error response.
type ErrorResponseBody struct {
// Code - Error code, intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - Description of the error, intended for display in user interface.
Message *string `json:"message,omitempty"`
// Target - Target of the particular error, for example name of the property.
Target *string `json:"target,omitempty"`
// Details - A list of additional details about the error.
Details *[]ErrorResponseBody `json:"details,omitempty"`
}
Essentials this object contains consistent fields across different monitor services.
type Essentials struct {
// Severity - READ-ONLY; Severity of alert Sev0 being highest and Sev4 being lowest. Possible values include: 'Sev0', 'Sev1', 'Sev2', 'Sev3', 'Sev4'
Severity Severity `json:"severity,omitempty"`
// SignalType - READ-ONLY; The type of signal the alert is based on, which could be metrics, logs or activity logs. Possible values include: 'Metric', 'Log', 'Unknown'
SignalType SignalType `json:"signalType,omitempty"`
// AlertState - READ-ONLY; Alert object state, which can be modified by the user. Possible values include: 'AlertStateNew', 'AlertStateAcknowledged', 'AlertStateClosed'
AlertState AlertState `json:"alertState,omitempty"`
// MonitorCondition - READ-ONLY; Condition of the rule at the monitor service. It represents whether the underlying conditions have crossed the defined alert rule thresholds. Possible values include: 'Fired', 'Resolved'
MonitorCondition MonitorCondition `json:"monitorCondition,omitempty"`
// TargetResource - Target ARM resource, on which alert got created.
TargetResource *string `json:"targetResource,omitempty"`
// TargetResourceName - Name of the target ARM resource name, on which alert got created.
TargetResourceName *string `json:"targetResourceName,omitempty"`
// TargetResourceGroup - Resource group of target ARM resource, on which alert got created.
TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
// TargetResourceType - Resource type of target ARM resource, on which alert got created.
TargetResourceType *string `json:"targetResourceType,omitempty"`
// MonitorService - READ-ONLY; Monitor service on which the rule(monitor) is set. Possible values include: 'ApplicationInsights', 'ActivityLogAdministrative', 'ActivityLogSecurity', 'ActivityLogRecommendation', 'ActivityLogPolicy', 'ActivityLogAutoscale', 'LogAnalytics', 'Nagios', 'Platform', 'SCOM', 'ServiceHealth', 'SmartDetector', 'VMInsights', 'Zabbix'
MonitorService MonitorService `json:"monitorService,omitempty"`
// AlertRule - READ-ONLY; Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule.
AlertRule *string `json:"alertRule,omitempty"`
// SourceCreatedID - READ-ONLY; Unique Id created by monitor service for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc.
SourceCreatedID *string `json:"sourceCreatedId,omitempty"`
// SmartGroupID - READ-ONLY; Unique Id of the smart group
SmartGroupID *string `json:"smartGroupId,omitempty"`
// SmartGroupingReason - READ-ONLY; Verbose reason describing the reason why this alert instance is added to a smart group
SmartGroupingReason *string `json:"smartGroupingReason,omitempty"`
// StartDateTime - READ-ONLY; Creation time(ISO-8601 format) of alert instance.
StartDateTime *date.Time `json:"startDateTime,omitempty"`
// LastModifiedDateTime - READ-ONLY; Last modification time(ISO-8601 format) of alert instance.
LastModifiedDateTime *date.Time `json:"lastModifiedDateTime,omitempty"`
// MonitorConditionResolvedDateTime - READ-ONLY; Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.
MonitorConditionResolvedDateTime *date.Time `json:"monitorConditionResolvedDateTime,omitempty"`
// LastModifiedUserName - READ-ONLY; User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user.
LastModifiedUserName *string `json:"lastModifiedUserName,omitempty"`
}
func (e Essentials) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Essentials.
ManagedResource an azure managed resource object
type ManagedResource struct {
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (mr ManagedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedResource.
MetadataIdentifier enumerates the values for metadata identifier.
type MetadataIdentifier string
const (
// MetadataIdentifierAlertsMetaDataProperties ...
MetadataIdentifierAlertsMetaDataProperties MetadataIdentifier = "alertsMetaDataProperties"
// MetadataIdentifierMonitorServiceList ...
MetadataIdentifierMonitorServiceList MetadataIdentifier = "MonitorServiceList"
)
func PossibleMetadataIdentifierValues() []MetadataIdentifier
PossibleMetadataIdentifierValues returns an array of possible values for the MetadataIdentifier const type.
MonitorCondition enumerates the values for monitor condition.
type MonitorCondition string
const (
// Fired ...
Fired MonitorCondition = "Fired"
// Resolved ...
Resolved MonitorCondition = "Resolved"
)
func PossibleMonitorConditionValues() []MonitorCondition
PossibleMonitorConditionValues returns an array of possible values for the MonitorCondition const type.
MonitorService enumerates the values for monitor service.
type MonitorService string
const (
// ActivityLogAdministrative ...
ActivityLogAdministrative MonitorService = "ActivityLog Administrative"
// ActivityLogAutoscale ...
ActivityLogAutoscale MonitorService = "ActivityLog Autoscale"
// ActivityLogPolicy ...
ActivityLogPolicy MonitorService = "ActivityLog Policy"
// ActivityLogRecommendation ...
ActivityLogRecommendation MonitorService = "ActivityLog Recommendation"
// ActivityLogSecurity ...
ActivityLogSecurity MonitorService = "ActivityLog Security"
// ApplicationInsights ...
ApplicationInsights MonitorService = "Application Insights"
// LogAnalytics ...
LogAnalytics MonitorService = "Log Analytics"
// Nagios ...
Nagios MonitorService = "Nagios"
// Platform ...
Platform MonitorService = "Platform"
// SCOM ...
SCOM MonitorService = "SCOM"
// ServiceHealth ...
ServiceHealth MonitorService = "ServiceHealth"
// SmartDetector ...
SmartDetector MonitorService = "SmartDetector"
// VMInsights ...
VMInsights MonitorService = "VM Insights"
// Zabbix ...
Zabbix MonitorService = "Zabbix"
)
func PossibleMonitorServiceValues() []MonitorService
PossibleMonitorServiceValues returns an array of possible values for the MonitorService const type.
MonitorServiceDetails details of a monitor service
type MonitorServiceDetails struct {
// Name - Monitor service name
Name *string `json:"name,omitempty"`
// DisplayName - Monitor service display name
DisplayName *string `json:"displayName,omitempty"`
}
MonitorServiceList monitor service details
type MonitorServiceList struct {
// Data - Array of operations
Data *[]MonitorServiceDetails `json:"data,omitempty"`
// MetadataIdentifier - Possible values include: 'MetadataIdentifierAlertsMetaDataProperties', 'MetadataIdentifierMonitorServiceList'
MetadataIdentifier MetadataIdentifier `json:"metadataIdentifier,omitempty"`
}
func (msl MonitorServiceList) AsAlertsMetaDataProperties() (*AlertsMetaDataProperties, bool)
AsAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for MonitorServiceList.
func (msl MonitorServiceList) AsBasicAlertsMetaDataProperties() (BasicAlertsMetaDataProperties, bool)
AsBasicAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for MonitorServiceList.
func (msl MonitorServiceList) AsMonitorServiceList() (*MonitorServiceList, bool)
AsMonitorServiceList is the BasicAlertsMetaDataProperties implementation for MonitorServiceList.
func (msl MonitorServiceList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MonitorServiceList.
Operation operation provided by provider
type Operation struct {
// Name - Name of the operation
Name *string `json:"name,omitempty"`
// Display - Properties of the operation
Display *OperationDisplay `json:"display,omitempty"`
}
OperationDisplay properties of the operation
type OperationDisplay struct {
// Provider - Provider name
Provider *string `json:"provider,omitempty"`
// Resource - Resource name
Resource *string `json:"resource,omitempty"`
// Operation - Operation name
Operation *string `json:"operation,omitempty"`
// Description - Description of the operation
Description *string `json:"description,omitempty"`
}
OperationsClient is the alertsManagement Client
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationsListPage, err error)
List list all operations available through Azure Alerts Management Resource Provider.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationsListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
OperationsList lists the operations available in the AlertsManagement RP.
type OperationsList struct {
autorest.Response `json:"-"`
// NextLink - URL to fetch the next set of alerts.
NextLink *string `json:"nextLink,omitempty"`
// Value - Array of operations
Value *[]Operation `json:"value,omitempty"`
}
func (ol OperationsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OperationsListIterator provides access to a complete listing of Operation values.
type OperationsListIterator struct {
// contains filtered or unexported fields
}
func NewOperationsListIterator(page OperationsListPage) OperationsListIterator
Creates a new instance of the OperationsListIterator type.
func (iter *OperationsListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationsListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationsListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationsListIterator) Response() OperationsList
Response returns the raw server response from the last page request.
func (iter OperationsListIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationsListPage contains a page of Operation values.
type OperationsListPage struct {
// contains filtered or unexported fields
}
func NewOperationsListPage(cur OperationsList, getNextPage func(context.Context, OperationsList) (OperationsList, error)) OperationsListPage
Creates a new instance of the OperationsListPage type.
func (page *OperationsListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationsListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationsListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationsListPage) Response() OperationsList
Response returns the raw server response from the last page request.
func (page OperationsListPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
Operator enumerates the values for operator.
type Operator string
const (
// Contains ...
Contains Operator = "Contains"
// DoesNotContain ...
DoesNotContain Operator = "DoesNotContain"
// Equals ...
Equals Operator = "Equals"
// NotEquals ...
NotEquals Operator = "NotEquals"
)
func PossibleOperatorValues() []Operator
PossibleOperatorValues returns an array of possible values for the Operator const type.
PatchObject data contract for patch
type PatchObject struct {
// PatchProperties - properties supported by patch operation
*PatchProperties `json:"properties,omitempty"`
// Tags - tags to be updated
Tags interface{} `json:"tags,omitempty"`
}
func (po PatchObject) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchObject.
func (po *PatchObject) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PatchObject struct.
PatchProperties action rule properties supported by patch
type PatchProperties struct {
// Status - Indicates if the given action rule is enabled or disabled. Possible values include: 'Enabled', 'Disabled'
Status ActionRuleStatus `json:"status,omitempty"`
}
Resource an azure resource object
type Resource struct {
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
Scope target scope for a given action rule. By default scope will be the subscription. User can also provide list of resource groups or list of resources from the scope subscription as well.
type Scope struct {
// ScopeType - type of target scope. Possible values include: 'ScopeTypeResourceGroup', 'ScopeTypeResource', 'ScopeTypeSubscription'
ScopeType ScopeType `json:"scopeType,omitempty"`
// Values - list of ARM IDs of the given scope type which will be the target of the given action rule.
Values *[]string `json:"values,omitempty"`
}
ScopeType enumerates the values for scope type.
type ScopeType string
const (
// ScopeTypeResource ...
ScopeTypeResource ScopeType = "Resource"
// ScopeTypeResourceGroup ...
ScopeTypeResourceGroup ScopeType = "ResourceGroup"
// ScopeTypeSubscription ...
ScopeTypeSubscription ScopeType = "Subscription"
)
func PossibleScopeTypeValues() []ScopeType
PossibleScopeTypeValues returns an array of possible values for the ScopeType const type.
Severity enumerates the values for severity.
type Severity string
const (
// Sev0 ...
Sev0 Severity = "Sev0"
// Sev1 ...
Sev1 Severity = "Sev1"
// Sev2 ...
Sev2 Severity = "Sev2"
// Sev3 ...
Sev3 Severity = "Sev3"
// Sev4 ...
Sev4 Severity = "Sev4"
)
func PossibleSeverityValues() []Severity
PossibleSeverityValues returns an array of possible values for the Severity const type.
SignalType enumerates the values for signal type.
type SignalType string
const (
// Log ...
Log SignalType = "Log"
// Metric ...
Metric SignalType = "Metric"
// Unknown ...
Unknown SignalType = "Unknown"
)
func PossibleSignalTypeValues() []SignalType
PossibleSignalTypeValues returns an array of possible values for the SignalType const type.
SmartDetectorAlertRulesClient is the alertsManagement Client
type SmartDetectorAlertRulesClient struct {
BaseClient
}
func NewSmartDetectorAlertRulesClient(subscriptionID string) SmartDetectorAlertRulesClient
NewSmartDetectorAlertRulesClient creates an instance of the SmartDetectorAlertRulesClient client.
func NewSmartDetectorAlertRulesClientWithBaseURI(baseURI string, subscriptionID string) SmartDetectorAlertRulesClient
NewSmartDetectorAlertRulesClientWithBaseURI creates an instance of the SmartDetectorAlertRulesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client SmartDetectorAlertRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, alertRuleName string, parameters AlertRule) (result AlertRule, err error)
CreateOrUpdate create or update a Smart Detector alert rule. Parameters: resourceGroupName - the name of the resource group. alertRuleName - the name of the alert rule. parameters - parameters supplied to the operation.
func (client SmartDetectorAlertRulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, alertRuleName string, parameters AlertRule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SmartDetectorAlertRulesClient) CreateOrUpdateResponder(resp *http.Response) (result AlertRule, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SmartDetectorAlertRulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SmartDetectorAlertRulesClient) Delete(ctx context.Context, resourceGroupName string, alertRuleName string) (result autorest.Response, err error)
Delete delete an existing Smart Detector alert rule. Parameters: resourceGroupName - the name of the resource group. alertRuleName - the name of the alert rule.
func (client SmartDetectorAlertRulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, alertRuleName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SmartDetectorAlertRulesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client SmartDetectorAlertRulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SmartDetectorAlertRulesClient) Get(ctx context.Context, resourceGroupName string, alertRuleName string, expandDetector *bool) (result AlertRule, err error)
Get get a specific Smart Detector alert rule. Parameters: resourceGroupName - the name of the resource group. alertRuleName - the name of the alert rule. expandDetector - indicates if Smart Detector should be expanded.
func (client SmartDetectorAlertRulesClient) GetPreparer(ctx context.Context, resourceGroupName string, alertRuleName string, expandDetector *bool) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SmartDetectorAlertRulesClient) GetResponder(resp *http.Response) (result AlertRule, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SmartDetectorAlertRulesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SmartDetectorAlertRulesClient) List(ctx context.Context, expandDetector *bool) (result AlertRulesListPage, err error)
List list all the existing Smart Detector alert rules within the subscription. Parameters: expandDetector - indicates if Smart Detector should be expanded.
func (client SmartDetectorAlertRulesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expandDetector *bool) (result AlertRulesListPage, err error)
ListByResourceGroup list all the existing Smart Detector alert rules within the subscription and resource group. Parameters: resourceGroupName - the name of the resource group. expandDetector - indicates if Smart Detector should be expanded.
func (client SmartDetectorAlertRulesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expandDetector *bool) (result AlertRulesListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client SmartDetectorAlertRulesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expandDetector *bool) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client SmartDetectorAlertRulesClient) ListByResourceGroupResponder(resp *http.Response) (result AlertRulesList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client SmartDetectorAlertRulesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client SmartDetectorAlertRulesClient) ListComplete(ctx context.Context, expandDetector *bool) (result AlertRulesListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SmartDetectorAlertRulesClient) ListPreparer(ctx context.Context, expandDetector *bool) (*http.Request, error)
ListPreparer prepares the List request.
func (client SmartDetectorAlertRulesClient) ListResponder(resp *http.Response) (result AlertRulesList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SmartDetectorAlertRulesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client SmartDetectorAlertRulesClient) Patch(ctx context.Context, resourceGroupName string, alertRuleName string, parameters AlertRulePatchObject) (result AlertRule, err error)
Patch patch a specific Smart Detector alert rule. Parameters: resourceGroupName - the name of the resource group. alertRuleName - the name of the alert rule. parameters - parameters supplied to the operation.
func (client SmartDetectorAlertRulesClient) PatchPreparer(ctx context.Context, resourceGroupName string, alertRuleName string, parameters AlertRulePatchObject) (*http.Request, error)
PatchPreparer prepares the Patch request.
func (client SmartDetectorAlertRulesClient) PatchResponder(resp *http.Response) (result AlertRule, err error)
PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.
func (client SmartDetectorAlertRulesClient) PatchSender(req *http.Request) (*http.Response, error)
PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.
SmartDetectorErrorResponse describe the format of an Error response.
type SmartDetectorErrorResponse struct {
// Code - Error code
Code *string `json:"code,omitempty"`
// Message - Error message indicating why the operation failed.
Message *string `json:"message,omitempty"`
}
SmartGroup set of related alerts grouped together smartly by AMS.
type SmartGroup struct {
autorest.Response `json:"-"`
*SmartGroupProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (sg SmartGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroup.
func (sg *SmartGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SmartGroup struct.
SmartGroupAggregatedProperty aggregated property of each type
type SmartGroupAggregatedProperty struct {
// Name - Name of the type.
Name *string `json:"name,omitempty"`
// Count - Total number of items of type.
Count *int32 `json:"count,omitempty"`
}
SmartGroupModification alert Modification details
type SmartGroupModification struct {
autorest.Response `json:"-"`
Properties *SmartGroupModificationProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Azure resource Id
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; Azure resource type
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; Azure resource name
Name *string `json:"name,omitempty"`
}
func (sgm SmartGroupModification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroupModification.
SmartGroupModificationEvent enumerates the values for smart group modification event.
type SmartGroupModificationEvent string
const (
// SmartGroupModificationEventAlertAdded ...
SmartGroupModificationEventAlertAdded SmartGroupModificationEvent = "AlertAdded"
// SmartGroupModificationEventAlertRemoved ...
SmartGroupModificationEventAlertRemoved SmartGroupModificationEvent = "AlertRemoved"
// SmartGroupModificationEventSmartGroupCreated ...
SmartGroupModificationEventSmartGroupCreated SmartGroupModificationEvent = "SmartGroupCreated"
// SmartGroupModificationEventStateChange ...
SmartGroupModificationEventStateChange SmartGroupModificationEvent = "StateChange"
)
func PossibleSmartGroupModificationEventValues() []SmartGroupModificationEvent
PossibleSmartGroupModificationEventValues returns an array of possible values for the SmartGroupModificationEvent const type.
SmartGroupModificationItem smartGroup modification item.
type SmartGroupModificationItem struct {
// ModificationEvent - Reason for the modification. Possible values include: 'SmartGroupModificationEventSmartGroupCreated', 'SmartGroupModificationEventStateChange', 'SmartGroupModificationEventAlertAdded', 'SmartGroupModificationEventAlertRemoved'
ModificationEvent SmartGroupModificationEvent `json:"modificationEvent,omitempty"`
// OldValue - Old value
OldValue *string `json:"oldValue,omitempty"`
// NewValue - New value
NewValue *string `json:"newValue,omitempty"`
// ModifiedAt - Modified date and time
ModifiedAt *string `json:"modifiedAt,omitempty"`
// ModifiedBy - Modified user details (Principal client name)
ModifiedBy *string `json:"modifiedBy,omitempty"`
// Comments - Modification comments
Comments *string `json:"comments,omitempty"`
// Description - Description of the modification
Description *string `json:"description,omitempty"`
}
SmartGroupModificationProperties properties of the smartGroup modification item.
type SmartGroupModificationProperties struct {
// SmartGroupID - READ-ONLY; Unique Id of the smartGroup for which the history is being retrieved
SmartGroupID *string `json:"smartGroupId,omitempty"`
// Modifications - Modification details
Modifications *[]SmartGroupModificationItem `json:"modifications,omitempty"`
// NextLink - URL to fetch the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (sgmp SmartGroupModificationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroupModificationProperties.
SmartGroupProperties properties of smart group.
type SmartGroupProperties struct {
// AlertsCount - Total number of alerts in smart group
AlertsCount *int32 `json:"alertsCount,omitempty"`
// SmartGroupState - READ-ONLY; Smart group state. Possible values include: 'StateNew', 'StateAcknowledged', 'StateClosed'
SmartGroupState State `json:"smartGroupState,omitempty"`
// Severity - READ-ONLY; Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. Possible values include: 'Sev0', 'Sev1', 'Sev2', 'Sev3', 'Sev4'
Severity Severity `json:"severity,omitempty"`
// StartDateTime - READ-ONLY; Creation time of smart group. Date-Time in ISO-8601 format.
StartDateTime *date.Time `json:"startDateTime,omitempty"`
// LastModifiedDateTime - READ-ONLY; Last updated time of smart group. Date-Time in ISO-8601 format.
LastModifiedDateTime *date.Time `json:"lastModifiedDateTime,omitempty"`
// LastModifiedUserName - READ-ONLY; Last modified by user name.
LastModifiedUserName *string `json:"lastModifiedUserName,omitempty"`
// Resources - Summary of target resources in the smart group
Resources *[]SmartGroupAggregatedProperty `json:"resources,omitempty"`
// ResourceTypes - Summary of target resource types in the smart group
ResourceTypes *[]SmartGroupAggregatedProperty `json:"resourceTypes,omitempty"`
// ResourceGroups - Summary of target resource groups in the smart group
ResourceGroups *[]SmartGroupAggregatedProperty `json:"resourceGroups,omitempty"`
// MonitorServices - Summary of monitorServices in the smart group
MonitorServices *[]SmartGroupAggregatedProperty `json:"monitorServices,omitempty"`
// MonitorConditions - Summary of monitorConditions in the smart group
MonitorConditions *[]SmartGroupAggregatedProperty `json:"monitorConditions,omitempty"`
// AlertStates - Summary of alertStates in the smart group
AlertStates *[]SmartGroupAggregatedProperty `json:"alertStates,omitempty"`
// AlertSeverities - Summary of alertSeverities in the smart group
AlertSeverities *[]SmartGroupAggregatedProperty `json:"alertSeverities,omitempty"`
// NextLink - The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts.
NextLink *string `json:"nextLink,omitempty"`
}
func (sgp SmartGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroupProperties.
SmartGroupsClient is the alertsManagement Client
type SmartGroupsClient struct {
BaseClient
}
func NewSmartGroupsClient(subscriptionID string) SmartGroupsClient
NewSmartGroupsClient creates an instance of the SmartGroupsClient client.
func NewSmartGroupsClientWithBaseURI(baseURI string, subscriptionID string) SmartGroupsClient
NewSmartGroupsClientWithBaseURI creates an instance of the SmartGroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client SmartGroupsClient) ChangeState(ctx context.Context, smartGroupID string, newState AlertState) (result SmartGroup, err error)
ChangeState change the state of a Smart Group. Parameters: smartGroupID - smart group unique id. newState - new state of the alert.
func (client SmartGroupsClient) ChangeStatePreparer(ctx context.Context, smartGroupID string, newState AlertState) (*http.Request, error)
ChangeStatePreparer prepares the ChangeState request.
func (client SmartGroupsClient) ChangeStateResponder(resp *http.Response) (result SmartGroup, err error)
ChangeStateResponder handles the response to the ChangeState request. The method always closes the http.Response Body.
func (client SmartGroupsClient) ChangeStateSender(req *http.Request) (*http.Response, error)
ChangeStateSender sends the ChangeState request. The method will close the http.Response Body if it receives an error.
func (client SmartGroupsClient) GetAll(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, smartGroupState AlertState, timeRange TimeRange, pageCount *int32, sortBy SmartGroupsSortByFields, sortOrder string) (result SmartGroupsListPage, err error)
GetAll list all the Smart Groups within a specified subscription. Parameters: targetResource - filter by target resource( which is full ARM ID) Default value is select all. targetResourceGroup - filter by target resource group name. Default value is select all. targetResourceType - filter by target resource type. Default value is select all. monitorService - filter by monitor service which generates the alert instance. Default value is select all. monitorCondition - filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. severity - filter by severity. Default value is select all. smartGroupState - filter by state of the smart group. Default value is to select all. timeRange - filter by time range by below listed values. Default value is 1 day. pageCount - determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25. sortBy - sort the query results by input field. Default value is sort by 'lastModifiedDateTime'. sortOrder - sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.
func (client SmartGroupsClient) GetAllComplete(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, smartGroupState AlertState, timeRange TimeRange, pageCount *int32, sortBy SmartGroupsSortByFields, sortOrder string) (result SmartGroupsListIterator, err error)
GetAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client SmartGroupsClient) GetAllPreparer(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorService MonitorService, monitorCondition MonitorCondition, severity Severity, smartGroupState AlertState, timeRange TimeRange, pageCount *int32, sortBy SmartGroupsSortByFields, sortOrder string) (*http.Request, error)
GetAllPreparer prepares the GetAll request.
func (client SmartGroupsClient) GetAllResponder(resp *http.Response) (result SmartGroupsList, err error)
GetAllResponder handles the response to the GetAll request. The method always closes the http.Response Body.
func (client SmartGroupsClient) GetAllSender(req *http.Request) (*http.Response, error)
GetAllSender sends the GetAll request. The method will close the http.Response Body if it receives an error.
func (client SmartGroupsClient) GetByID(ctx context.Context, smartGroupID string) (result SmartGroup, err error)
GetByID get information related to a specific Smart Group. Parameters: smartGroupID - smart group unique id.
func (client SmartGroupsClient) GetByIDPreparer(ctx context.Context, smartGroupID string) (*http.Request, error)
GetByIDPreparer prepares the GetByID request.
func (client SmartGroupsClient) GetByIDResponder(resp *http.Response) (result SmartGroup, err error)
GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.
func (client SmartGroupsClient) GetByIDSender(req *http.Request) (*http.Response, error)
GetByIDSender sends the GetByID request. The method will close the http.Response Body if it receives an error.
func (client SmartGroupsClient) GetHistory(ctx context.Context, smartGroupID string) (result SmartGroupModification, err error)
GetHistory get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) . Parameters: smartGroupID - smart group unique id.
func (client SmartGroupsClient) GetHistoryPreparer(ctx context.Context, smartGroupID string) (*http.Request, error)
GetHistoryPreparer prepares the GetHistory request.
func (client SmartGroupsClient) GetHistoryResponder(resp *http.Response) (result SmartGroupModification, err error)
GetHistoryResponder handles the response to the GetHistory request. The method always closes the http.Response Body.
func (client SmartGroupsClient) GetHistorySender(req *http.Request) (*http.Response, error)
GetHistorySender sends the GetHistory request. The method will close the http.Response Body if it receives an error.
SmartGroupsList list the alerts.
type SmartGroupsList struct {
autorest.Response `json:"-"`
// NextLink - URL to fetch the next set of alerts.
NextLink *string `json:"nextLink,omitempty"`
// Value - List of alerts
Value *[]SmartGroup `json:"value,omitempty"`
}
func (sgl SmartGroupsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SmartGroupsListIterator provides access to a complete listing of SmartGroup values.
type SmartGroupsListIterator struct {
// contains filtered or unexported fields
}
func NewSmartGroupsListIterator(page SmartGroupsListPage) SmartGroupsListIterator
Creates a new instance of the SmartGroupsListIterator type.
func (iter *SmartGroupsListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SmartGroupsListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SmartGroupsListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SmartGroupsListIterator) Response() SmartGroupsList
Response returns the raw server response from the last page request.
func (iter SmartGroupsListIterator) Value() SmartGroup
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SmartGroupsListPage contains a page of SmartGroup values.
type SmartGroupsListPage struct {
// contains filtered or unexported fields
}
func NewSmartGroupsListPage(cur SmartGroupsList, getNextPage func(context.Context, SmartGroupsList) (SmartGroupsList, error)) SmartGroupsListPage
Creates a new instance of the SmartGroupsListPage type.
func (page *SmartGroupsListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SmartGroupsListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SmartGroupsListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SmartGroupsListPage) Response() SmartGroupsList
Response returns the raw server response from the last page request.
func (page SmartGroupsListPage) Values() []SmartGroup
Values returns the slice of values for the current page or nil if there are no values.
SmartGroupsSortByFields enumerates the values for smart groups sort by fields.
type SmartGroupsSortByFields string
const (
// SmartGroupsSortByFieldsAlertsCount ...
SmartGroupsSortByFieldsAlertsCount SmartGroupsSortByFields = "alertsCount"
// SmartGroupsSortByFieldsLastModifiedDateTime ...
SmartGroupsSortByFieldsLastModifiedDateTime SmartGroupsSortByFields = "lastModifiedDateTime"
// SmartGroupsSortByFieldsSeverity ...
SmartGroupsSortByFieldsSeverity SmartGroupsSortByFields = "severity"
// SmartGroupsSortByFieldsStartDateTime ...
SmartGroupsSortByFieldsStartDateTime SmartGroupsSortByFields = "startDateTime"
// SmartGroupsSortByFieldsState ...
SmartGroupsSortByFieldsState SmartGroupsSortByFields = "state"
)
func PossibleSmartGroupsSortByFieldsValues() []SmartGroupsSortByFields
PossibleSmartGroupsSortByFieldsValues returns an array of possible values for the SmartGroupsSortByFields const type.
State enumerates the values for state.
type State string
const (
// StateAcknowledged ...
StateAcknowledged State = "Acknowledged"
// StateClosed ...
StateClosed State = "Closed"
// StateNew ...
StateNew State = "New"
)
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
Suppression action rule with suppression configuration
type Suppression struct {
// SuppressionConfig - suppression configuration for the action rule
SuppressionConfig *SuppressionConfig `json:"suppressionConfig,omitempty"`
// Scope - scope on which action rule will apply
Scope *Scope `json:"scope,omitempty"`
// Conditions - conditions on which alerts will be filtered
Conditions *Conditions `json:"conditions,omitempty"`
// Description - Description of action rule
Description *string `json:"description,omitempty"`
// CreatedAt - READ-ONLY; Creation time of action rule. Date-Time in ISO-8601 format.
CreatedAt *date.Time `json:"createdAt,omitempty"`
// LastModifiedAt - READ-ONLY; Last updated time of action rule. Date-Time in ISO-8601 format.
LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
// CreatedBy - READ-ONLY; Created by user name.
CreatedBy *string `json:"createdBy,omitempty"`
// LastModifiedBy - READ-ONLY; Last modified by user name.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// Status - Indicates if the given action rule is enabled or disabled. Possible values include: 'Enabled', 'Disabled'
Status ActionRuleStatus `json:"status,omitempty"`
// Type - Possible values include: 'TypeActionRuleProperties', 'TypeSuppression', 'TypeActionGroup', 'TypeDiagnostics'
Type Type `json:"type,omitempty"`
}
func (s Suppression) AsActionGroup() (*ActionGroup, bool)
AsActionGroup is the BasicActionRuleProperties implementation for Suppression.
func (s Suppression) AsActionRuleProperties() (*ActionRuleProperties, bool)
AsActionRuleProperties is the BasicActionRuleProperties implementation for Suppression.
func (s Suppression) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)
AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for Suppression.
func (s Suppression) AsDiagnostics() (*Diagnostics, bool)
AsDiagnostics is the BasicActionRuleProperties implementation for Suppression.
func (s Suppression) AsSuppression() (*Suppression, bool)
AsSuppression is the BasicActionRuleProperties implementation for Suppression.
func (s Suppression) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Suppression.
SuppressionConfig suppression logic for a given action rule
type SuppressionConfig struct {
// RecurrenceType - Specifies when the suppression should be applied. Possible values include: 'Always', 'Once', 'Daily', 'Weekly', 'Monthly'
RecurrenceType SuppressionType `json:"recurrenceType,omitempty"`
// Schedule - suppression schedule configuration
Schedule *SuppressionSchedule `json:"schedule,omitempty"`
}
SuppressionSchedule schedule for a given suppression configuration.
type SuppressionSchedule struct {
// StartDate - Start date for suppression
StartDate *string `json:"startDate,omitempty"`
// EndDate - End date for suppression
EndDate *string `json:"endDate,omitempty"`
// StartTime - Start time for suppression
StartTime *string `json:"startTime,omitempty"`
// EndTime - End date for suppression
EndTime *string `json:"endTime,omitempty"`
// RecurrenceValues - Specifies the values for recurrence pattern
RecurrenceValues *[]int32 `json:"recurrenceValues,omitempty"`
}
SuppressionType enumerates the values for suppression type.
type SuppressionType string
const (
// Always ...
Always SuppressionType = "Always"
// Daily ...
Daily SuppressionType = "Daily"
// Monthly ...
Monthly SuppressionType = "Monthly"
// Once ...
Once SuppressionType = "Once"
// Weekly ...
Weekly SuppressionType = "Weekly"
)
func PossibleSuppressionTypeValues() []SuppressionType
PossibleSuppressionTypeValues returns an array of possible values for the SuppressionType const type.
ThrottlingInformation optional throttling information for the alert rule.
type ThrottlingInformation struct {
// 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
Duration *string `json:"duration,omitempty"`
}
TimeRange enumerates the values for time range.
type TimeRange string
const (
// Oned ...
Oned TimeRange = "1d"
// Oneh ...
Oneh TimeRange = "1h"
// Sevend ...
Sevend TimeRange = "7d"
// ThreeZerod ...
ThreeZerod TimeRange = "30d"
)
func PossibleTimeRangeValues() []TimeRange
PossibleTimeRangeValues returns an array of possible values for the TimeRange const type.
Type enumerates the values for type.
type Type string
const (
// TypeActionGroup ...
TypeActionGroup Type = "ActionGroup"
// TypeActionRuleProperties ...
TypeActionRuleProperties Type = "ActionRuleProperties"
// TypeDiagnostics ...
TypeDiagnostics Type = "Diagnostics"
// TypeSuppression ...
TypeSuppression Type = "Suppression"
)
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.
| Name | Synopsis |
|---|---|
| .. | |
| alertsmanagementapi | Deprecated: Please note, this package has been deprecated. |