alertsmanagement

package
v60.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 23, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package alertsmanagement implements the Azure ARM Alertsmanagement service API version 2018-05-05-preview.

AlertsManagement Client

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Alertsmanagement
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIVersion

type APIVersion string

APIVersion enumerates the values for api version.

const (
	// TwoZeroOneEightHyphenMinusZeroFiveHyphenMinusZeroFiveHyphenMinuspreview ...
	TwoZeroOneEightHyphenMinusZeroFiveHyphenMinusZeroFiveHyphenMinuspreview APIVersion = "2018-05-05-preview"
	// TwoZeroOneSevenHyphenMinusOneOneHyphenMinusOneFiveHyphenMinusprivatepreview ...
	TwoZeroOneSevenHyphenMinusOneOneHyphenMinusOneFiveHyphenMinusprivatepreview APIVersion = "2017-11-15-privatepreview"
)

func PossibleAPIVersionValues

func PossibleAPIVersionValues() []APIVersion

PossibleAPIVersionValues returns an array of possible values for the APIVersion const type.

type Alert

type Alert struct {
	autorest.Response `json:"-"`
	*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"`
}

Alert an alert created in alert management service.

func (Alert) MarshalJSON

func (a Alert) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Alert.

func (*Alert) UnmarshalJSON

func (a *Alert) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Alert struct.

type AlertModification

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"`
}

AlertModification alert Modification details

func (AlertModification) MarshalJSON

func (am AlertModification) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertModification.

type AlertModificationEvent

type AlertModificationEvent string

AlertModificationEvent enumerates the values for alert modification event.

const (
	// AlertCreated ...
	AlertCreated AlertModificationEvent = "AlertCreated"
	// MonitorConditionChange ...
	MonitorConditionChange AlertModificationEvent = "MonitorConditionChange"
	// StateChange ...
	StateChange AlertModificationEvent = "StateChange"
)

func PossibleAlertModificationEventValues

func PossibleAlertModificationEventValues() []AlertModificationEvent

PossibleAlertModificationEventValues returns an array of possible values for the AlertModificationEvent const type.

type AlertModificationItem

type AlertModificationItem struct {
	// ModificationEvent - Reason for the modification. Possible values include: 'AlertCreated', 'StateChange', 'MonitorConditionChange'
	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"`
}

AlertModificationItem alert modification item.

type AlertModificationProperties

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"`
}

AlertModificationProperties properties of the alert modification item.

func (AlertModificationProperties) MarshalJSON

func (amp AlertModificationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertModificationProperties.

type AlertProperties

type AlertProperties struct {
	// Severity - READ-ONLY; Severity of alert Sev1 being highest and Sev3 being lowest. Possible values include: 'Sev0', 'Sev1', 'Sev2', 'Sev3', 'Sev4'
	Severity Severity `json:"severity,omitempty"`
	// SignalType - READ-ONLY; Log based alert or metric based alert. Possible values include: 'Metric', 'Log', 'Unknown'
	SignalType SignalType `json:"signalType,omitempty"`
	// AlertState - READ-ONLY; Alert object state. Possible values include: 'AlertStateNew', 'AlertStateAcknowledged', 'AlertStateClosed'
	AlertState AlertState `json:"alertState,omitempty"`
	// MonitorCondition - READ-ONLY; Condition of the rule at the monitor service. 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 - Target ARM resource name, on which alert got created.
	TargetResourceName *string `json:"targetResourceName,omitempty"`
	// TargetResourceGroup - Resource group of target ARM resource.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
	// TargetResourceType - Resource type of target ARM resource
	TargetResourceType *string `json:"targetResourceType,omitempty"`
	// MonitorService - READ-ONLY; Monitor service which is the source of the alert object. Possible values include: 'Platform', 'ApplicationInsights', 'LogAnalytics', 'InfrastructureInsights', 'ActivityLogAdministrative', 'ActivityLogSecurity', 'ActivityLogRecommendation', 'ActivityLogPolicy', 'ActivityLogAutoscale', 'ServiceHealth', 'SmartDetector', 'Zabbix', 'SCOM', 'Nagios'
	MonitorService MonitorService `json:"monitorService,omitempty"`
	// SourceCreatedID - READ-ONLY; Unique Id created by monitor service
	SourceCreatedID *string `json:"sourceCreatedId,omitempty"`
	// SmartGroupID - READ-ONLY; Unique Id of the smart group
	SmartGroupID *string `json:"smartGroupId,omitempty"`
	// SmartGroupingReason - READ-ONLY; Reason for addition to a smart group
	SmartGroupingReason *string `json:"smartGroupingReason,omitempty"`
	// StartDateTime - READ-ONLY; Creation time(ISO-8601 format).
	StartDateTime *date.Time `json:"startDateTime,omitempty"`
	// LastModifiedDateTime - READ-ONLY; Last modification time(ISO-8601 format).
	LastModifiedDateTime *date.Time `json:"lastModifiedDateTime,omitempty"`
	// LastModifiedUserName - READ-ONLY; User who last modified the alert.
	LastModifiedUserName *string `json:"lastModifiedUserName,omitempty"`
	// Payload - READ-ONLY; More details which are contextual to the monitor service.
	Payload interface{} `json:"payload,omitempty"`
}

AlertProperties an alert created in alert management service.

func (AlertProperties) MarshalJSON

func (ap AlertProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertProperties.

type AlertState

type AlertState string

AlertState enumerates the values for alert state.

const (
	// AlertStateAcknowledged ...
	AlertStateAcknowledged AlertState = "Acknowledged"
	// AlertStateClosed ...
	AlertStateClosed AlertState = "Closed"
	// AlertStateNew ...
	AlertStateNew AlertState = "New"
)

func PossibleAlertStateValues

func PossibleAlertStateValues() []AlertState

PossibleAlertStateValues returns an array of possible values for the AlertState const type.

type AlertsClient

type AlertsClient struct {
	BaseClient
}

AlertsClient is the alertsManagement Client

func NewAlertsClient

func NewAlertsClient(subscriptionID string, monitorService1 MonitorService) AlertsClient

NewAlertsClient creates an instance of the AlertsClient client.

func NewAlertsClientWithBaseURI

func NewAlertsClientWithBaseURI(baseURI string, subscriptionID string, monitorService1 MonitorService) 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 (AlertsClient) ChangeState

func (client AlertsClient) ChangeState(ctx context.Context, alertID string, newState AlertState) (result Alert, err error)

ChangeState change the state of the alert. Parameters: alertID - unique ID of an alert object. newState - filter by state

func (AlertsClient) ChangeStatePreparer

func (client AlertsClient) ChangeStatePreparer(ctx context.Context, alertID string, newState AlertState) (*http.Request, error)

ChangeStatePreparer prepares the ChangeState request.

func (AlertsClient) ChangeStateResponder

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 (AlertsClient) ChangeStateSender

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 (AlertsClient) GetAll

func (client AlertsClient) GetAll(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorCondition MonitorCondition, severity Severity, alertState AlertState, smartGroupID string, includePayload *bool, pageCount *int32, sortBy AlertsSortByFields, sortOrder string, timeRange TimeRange) (result AlertsListPage, err error)

GetAll list all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields. Parameters: targetResource - filter by target resource targetResourceGroup - filter by target resource group name targetResourceType - filter by target resource type monitorCondition - filter by monitor condition which is the state of the alert at monitor service severity - filter by severity alertState - filter by state smartGroupID - filter by smart Group Id includePayload - include payload field content, default value is 'false'. pageCount - number of items per page, 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. timeRange - filter by time range, default value is 1 day

func (AlertsClient) GetAllComplete

func (client AlertsClient) GetAllComplete(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorCondition MonitorCondition, severity Severity, alertState AlertState, smartGroupID string, includePayload *bool, pageCount *int32, sortBy AlertsSortByFields, sortOrder string, timeRange TimeRange) (result AlertsListIterator, err error)

GetAllComplete enumerates all values, automatically crossing page boundaries as required.

func (AlertsClient) GetAllPreparer

func (client AlertsClient) GetAllPreparer(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorCondition MonitorCondition, severity Severity, alertState AlertState, smartGroupID string, includePayload *bool, pageCount *int32, sortBy AlertsSortByFields, sortOrder string, timeRange TimeRange) (*http.Request, error)

GetAllPreparer prepares the GetAll request.

func (AlertsClient) GetAllResponder

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 (AlertsClient) GetAllSender

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 (AlertsClient) GetByID

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 object.

func (AlertsClient) GetByIDPreparer

func (client AlertsClient) GetByIDPreparer(ctx context.Context, alertID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (AlertsClient) GetByIDResponder

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 (AlertsClient) GetByIDSender

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 (AlertsClient) GetHistory

func (client AlertsClient) GetHistory(ctx context.Context, alertID string) (result AlertModification, err error)

GetHistory get the history of the changes of an alert. Parameters: alertID - unique ID of an alert object.

func (AlertsClient) GetHistoryPreparer

func (client AlertsClient) GetHistoryPreparer(ctx context.Context, alertID string) (*http.Request, error)

GetHistoryPreparer prepares the GetHistory request.

func (AlertsClient) GetHistoryResponder

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 (AlertsClient) GetHistorySender

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 (AlertsClient) GetSummary

func (client AlertsClient) GetSummary(ctx context.Context, targetResourceGroup string, timeRange TimeRange) (result AlertsSummary, err error)

GetSummary summary of alerts with the count each severity. Parameters: targetResourceGroup - filter by target resource group name timeRange - filter by time range, default value is 1 day

func (AlertsClient) GetSummaryPreparer

func (client AlertsClient) GetSummaryPreparer(ctx context.Context, targetResourceGroup string, timeRange TimeRange) (*http.Request, error)

GetSummaryPreparer prepares the GetSummary request.

func (AlertsClient) GetSummaryResponder

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 (AlertsClient) GetSummarySender

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.

type AlertsList

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"`
}

AlertsList list the alerts.

func (AlertsList) IsEmpty

func (al AlertsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AlertsListIterator

type AlertsListIterator struct {
	// contains filtered or unexported fields
}

AlertsListIterator provides access to a complete listing of Alert values.

func NewAlertsListIterator

func NewAlertsListIterator(page AlertsListPage) AlertsListIterator

Creates a new instance of the AlertsListIterator type.

func (*AlertsListIterator) Next

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 (*AlertsListIterator) NextWithContext

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 (AlertsListIterator) NotDone

func (iter AlertsListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AlertsListIterator) Response

func (iter AlertsListIterator) Response() AlertsList

Response returns the raw server response from the last page request.

func (AlertsListIterator) Value

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.

type AlertsListPage

type AlertsListPage struct {
	// contains filtered or unexported fields
}

AlertsListPage contains a page of Alert values.

func NewAlertsListPage

func NewAlertsListPage(cur AlertsList, getNextPage func(context.Context, AlertsList) (AlertsList, error)) AlertsListPage

Creates a new instance of the AlertsListPage type.

func (*AlertsListPage) Next

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 (*AlertsListPage) NextWithContext

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 (AlertsListPage) NotDone

func (page AlertsListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AlertsListPage) Response

func (page AlertsListPage) Response() AlertsList

Response returns the raw server response from the last page request.

func (AlertsListPage) Values

func (page AlertsListPage) Values() []Alert

Values returns the slice of values for the current page or nil if there are no values.

type AlertsSortByFields

type AlertsSortByFields string

AlertsSortByFields enumerates the values for alerts sort by fields.

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

func PossibleAlertsSortByFieldsValues() []AlertsSortByFields

PossibleAlertsSortByFieldsValues returns an array of possible values for the AlertsSortByFields const type.

type AlertsSummary

type AlertsSummary struct {
	autorest.Response        `json:"-"`
	*AlertsSummaryProperties `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"`
}

AlertsSummary summary of the alerts.

func (AlertsSummary) MarshalJSON

func (as AlertsSummary) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertsSummary.

func (*AlertsSummary) UnmarshalJSON

func (as *AlertsSummary) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AlertsSummary struct.

type AlertsSummaryByMonitorCondition

type AlertsSummaryByMonitorCondition struct {
	// Fired - Count of alerts with monitorCondition 'Fired'
	Fired *int32 `json:"fired,omitempty"`
	// Resolved - Count of alerts with monitorCondition 'Resolved'
	Resolved *int32 `json:"resolved,omitempty"`
}

AlertsSummaryByMonitorCondition summary of the alerts by monitor condition

type AlertsSummaryByMonitorService

type AlertsSummaryByMonitorService struct {
	// Platform - Count of alerts of "Platform"
	Platform *int32 `json:"platform,omitempty"`
	// ApplicationInsights - Count of alerts of "Application Insights"
	ApplicationInsights *int32 `json:"application Insights,omitempty"`
	// LogAnalytics - Count of alerts of "Log Analytics"
	LogAnalytics *int32 `json:"log Analytics,omitempty"`
	// Zabbix - Count of alerts of "Zabbix"
	Zabbix *int32 `json:"zabbix,omitempty"`
	// Scom - Count of alerts of "SCOM"
	Scom *int32 `json:"scom,omitempty"`
	// Nagios - Count of alerts of "Nagios"
	Nagios *int32 `json:"nagios,omitempty"`
	// InfrastructureInsights - Count of alerts of "Infrastructure Insights"
	InfrastructureInsights *int32 `json:"infrastructure Insights,omitempty"`
	// ActivityLogAdministrative - Count of alerts of "ActivityLog Administrative"
	ActivityLogAdministrative *int32 `json:"activityLog Administrative,omitempty"`
	// ActivityLogSecurity - Count of alerts of "ActivityLog Security"
	ActivityLogSecurity *int32 `json:"activityLog Security,omitempty"`
	// ActivityLogRecommendation - Count of alerts of "ActivityLog Recommendation"
	ActivityLogRecommendation *int32 `json:"activityLog Recommendation,omitempty"`
	// ActivityLogPolicy - Count of alerts of "ActivityLog Policy"
	ActivityLogPolicy *int32 `json:"activityLog Policy,omitempty"`
	// ActivityLogAutoscale - Count of alerts of "ActivityLog Autoscale"
	ActivityLogAutoscale *int32 `json:"activityLog Autoscale,omitempty"`
	// ServiceHealth - Count of alerts of "ServiceHealth"
	ServiceHealth *int32 `json:"serviceHealth,omitempty"`
	// SmartDetector - Count of alerts of "Smart Detector"
	SmartDetector *int32 `json:"smartDetector,omitempty"`
}

AlertsSummaryByMonitorService summary of the alerts by monitor service

type AlertsSummaryBySeverityAndMonitorCondition

type AlertsSummaryBySeverityAndMonitorCondition struct {
	// Sev0 - Summary of alerts by monitor condition with severity 'Sev0'
	Sev0 *AlertsSummaryBySeverityAndMonitorConditionSev0 `json:"sev0,omitempty"`
	// Sev1 - Summary of alerts by monitor condition with severity 'Sev1'
	Sev1 *AlertsSummaryBySeverityAndMonitorConditionSev1 `json:"sev1,omitempty"`
	// Sev2 - Summary of alerts by monitor condition with severity 'Sev2'
	Sev2 *AlertsSummaryBySeverityAndMonitorConditionSev2 `json:"sev2,omitempty"`
	// Sev3 - Summary of alerts by monitor condition with severity 'Sev3'
	Sev3 *AlertsSummaryBySeverityAndMonitorConditionSev3 `json:"sev3,omitempty"`
	// Sev4 - Summary of alerts by monitor condition with severity 'Sev4'
	Sev4 *AlertsSummaryBySeverityAndMonitorConditionSev4 `json:"sev4,omitempty"`
}

AlertsSummaryBySeverityAndMonitorCondition summary of the alerts by severity and monitor condition

type AlertsSummaryBySeverityAndMonitorConditionSev0

type AlertsSummaryBySeverityAndMonitorConditionSev0 struct {
	// Fired - Count of alerts with monitorCondition 'Fired'
	Fired *int32 `json:"fired,omitempty"`
	// Resolved - Count of alerts with monitorCondition 'Resolved'
	Resolved *int32 `json:"resolved,omitempty"`
}

AlertsSummaryBySeverityAndMonitorConditionSev0 summary of alerts by monitor condition with severity 'Sev0'

type AlertsSummaryBySeverityAndMonitorConditionSev1

type AlertsSummaryBySeverityAndMonitorConditionSev1 struct {
	// Fired - Count of alerts with monitorCondition 'Fired'
	Fired *int32 `json:"fired,omitempty"`
	// Resolved - Count of alerts with monitorCondition 'Resolved'
	Resolved *int32 `json:"resolved,omitempty"`
}

AlertsSummaryBySeverityAndMonitorConditionSev1 summary of alerts by monitor condition with severity 'Sev1'

type AlertsSummaryBySeverityAndMonitorConditionSev2

type AlertsSummaryBySeverityAndMonitorConditionSev2 struct {
	// Fired - Count of alerts with monitorCondition 'Fired'
	Fired *int32 `json:"fired,omitempty"`
	// Resolved - Count of alerts with monitorCondition 'Resolved'
	Resolved *int32 `json:"resolved,omitempty"`
}

AlertsSummaryBySeverityAndMonitorConditionSev2 summary of alerts by monitor condition with severity 'Sev2'

type AlertsSummaryBySeverityAndMonitorConditionSev3

type AlertsSummaryBySeverityAndMonitorConditionSev3 struct {
	// Fired - Count of alerts with monitorCondition 'Fired'
	Fired *int32 `json:"fired,omitempty"`
	// Resolved - Count of alerts with monitorCondition 'Resolved'
	Resolved *int32 `json:"resolved,omitempty"`
}

AlertsSummaryBySeverityAndMonitorConditionSev3 summary of alerts by monitor condition with severity 'Sev3'

type AlertsSummaryBySeverityAndMonitorConditionSev4

type AlertsSummaryBySeverityAndMonitorConditionSev4 struct {
	// Fired - Count of alerts with monitorCondition 'Fired'
	Fired *int32 `json:"fired,omitempty"`
	// Resolved - Count of alerts with monitorCondition 'Resolved'
	Resolved *int32 `json:"resolved,omitempty"`
}

AlertsSummaryBySeverityAndMonitorConditionSev4 summary of alerts by monitor condition with severity 'Sev4'

type AlertsSummaryByState

type AlertsSummaryByState struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryByState summary of alerts by state

type AlertsSummaryProperties

type AlertsSummaryProperties struct {
	// Total - Total number of alerts.
	Total *int32 `json:"total,omitempty"`
	// SmartGroupsCount - Total number of smart groups.
	SmartGroupsCount *int32 `json:"smartGroupsCount,omitempty"`
	// SummaryByState - Summary of alerts by state
	SummaryByState *AlertsSummaryPropertiesSummaryByState `json:"summaryByState,omitempty"`
	// SummaryBySeverity - Summary of alerts by severity
	SummaryBySeverity *AlertsSummaryPropertiesSummaryBySeverity `json:"summaryBySeverity,omitempty"`
	// SummaryBySeverityAndMonitorCondition - Summary of alerts by severity and monitor condition
	SummaryBySeverityAndMonitorCondition *AlertsSummaryPropertiesSummaryBySeverityAndMonitorCondition `json:"summaryBySeverityAndMonitorCondition,omitempty"`
	// SummaryByMonitorService - Summary of alerts by severity
	SummaryByMonitorService *AlertsSummaryPropertiesSummaryByMonitorService `json:"summaryByMonitorService,omitempty"`
	// NextLink - URL to fetch the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

AlertsSummaryProperties summary of the alerts

type AlertsSummaryPropertiesSummaryByMonitorService

type AlertsSummaryPropertiesSummaryByMonitorService struct {
	// Platform - Count of alerts of "Platform"
	Platform *int32 `json:"platform,omitempty"`
	// ApplicationInsights - Count of alerts of "Application Insights"
	ApplicationInsights *int32 `json:"application Insights,omitempty"`
	// LogAnalytics - Count of alerts of "Log Analytics"
	LogAnalytics *int32 `json:"log Analytics,omitempty"`
	// Zabbix - Count of alerts of "Zabbix"
	Zabbix *int32 `json:"zabbix,omitempty"`
	// Scom - Count of alerts of "SCOM"
	Scom *int32 `json:"scom,omitempty"`
	// Nagios - Count of alerts of "Nagios"
	Nagios *int32 `json:"nagios,omitempty"`
	// InfrastructureInsights - Count of alerts of "Infrastructure Insights"
	InfrastructureInsights *int32 `json:"infrastructure Insights,omitempty"`
	// ActivityLogAdministrative - Count of alerts of "ActivityLog Administrative"
	ActivityLogAdministrative *int32 `json:"activityLog Administrative,omitempty"`
	// ActivityLogSecurity - Count of alerts of "ActivityLog Security"
	ActivityLogSecurity *int32 `json:"activityLog Security,omitempty"`
	// ActivityLogRecommendation - Count of alerts of "ActivityLog Recommendation"
	ActivityLogRecommendation *int32 `json:"activityLog Recommendation,omitempty"`
	// ActivityLogPolicy - Count of alerts of "ActivityLog Policy"
	ActivityLogPolicy *int32 `json:"activityLog Policy,omitempty"`
	// ActivityLogAutoscale - Count of alerts of "ActivityLog Autoscale"
	ActivityLogAutoscale *int32 `json:"activityLog Autoscale,omitempty"`
	// ServiceHealth - Count of alerts of "ServiceHealth"
	ServiceHealth *int32 `json:"serviceHealth,omitempty"`
	// SmartDetector - Count of alerts of "Smart Detector"
	SmartDetector *int32 `json:"smartDetector,omitempty"`
}

AlertsSummaryPropertiesSummaryByMonitorService summary of alerts by severity

type AlertsSummaryPropertiesSummaryBySeverity

type AlertsSummaryPropertiesSummaryBySeverity struct {
	// Sev0 - Summary of alerts by severity 'Sev0'
	Sev0 *AlertsSummaryPropertiesSummaryBySeveritySev0 `json:"sev0,omitempty"`
	// Sev1 - Summary of alerts by severity 'Sev1'
	Sev1 *AlertsSummaryPropertiesSummaryBySeveritySev1 `json:"sev1,omitempty"`
	// Sev2 - Summary of alerts by severity 'Sev2'
	Sev2 *AlertsSummaryPropertiesSummaryBySeveritySev2 `json:"sev2,omitempty"`
	// Sev3 - Summary of alerts by severity 'Sev3'
	Sev3 *AlertsSummaryPropertiesSummaryBySeveritySev3 `json:"sev3,omitempty"`
	// Sev4 - Summary of alerts by severity 'Sev4'
	Sev4 *AlertsSummaryPropertiesSummaryBySeveritySev4 `json:"sev4,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeverity summary of alerts by severity

type AlertsSummaryPropertiesSummaryBySeverityAndMonitorCondition

type AlertsSummaryPropertiesSummaryBySeverityAndMonitorCondition struct {
	// Sev0 - Summary of alerts by monitor condition with severity 'Sev0'
	Sev0 *AlertsSummaryBySeverityAndMonitorConditionSev0 `json:"sev0,omitempty"`
	// Sev1 - Summary of alerts by monitor condition with severity 'Sev1'
	Sev1 *AlertsSummaryBySeverityAndMonitorConditionSev1 `json:"sev1,omitempty"`
	// Sev2 - Summary of alerts by monitor condition with severity 'Sev2'
	Sev2 *AlertsSummaryBySeverityAndMonitorConditionSev2 `json:"sev2,omitempty"`
	// Sev3 - Summary of alerts by monitor condition with severity 'Sev3'
	Sev3 *AlertsSummaryBySeverityAndMonitorConditionSev3 `json:"sev3,omitempty"`
	// Sev4 - Summary of alerts by monitor condition with severity 'Sev4'
	Sev4 *AlertsSummaryBySeverityAndMonitorConditionSev4 `json:"sev4,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeverityAndMonitorCondition summary of alerts by severity and monitor condition

type AlertsSummaryPropertiesSummaryBySeveritySev0

type AlertsSummaryPropertiesSummaryBySeveritySev0 struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeveritySev0 summary of alerts by severity 'Sev0'

type AlertsSummaryPropertiesSummaryBySeveritySev1

type AlertsSummaryPropertiesSummaryBySeveritySev1 struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeveritySev1 summary of alerts by severity 'Sev1'

type AlertsSummaryPropertiesSummaryBySeveritySev2

type AlertsSummaryPropertiesSummaryBySeveritySev2 struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeveritySev2 summary of alerts by severity 'Sev2'

type AlertsSummaryPropertiesSummaryBySeveritySev3

type AlertsSummaryPropertiesSummaryBySeveritySev3 struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeveritySev3 summary of alerts by severity 'Sev3'

type AlertsSummaryPropertiesSummaryBySeveritySev4

type AlertsSummaryPropertiesSummaryBySeveritySev4 struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryPropertiesSummaryBySeveritySev4 summary of alerts by severity 'Sev4'

type AlertsSummaryPropertiesSummaryByState

type AlertsSummaryPropertiesSummaryByState struct {
	// New - Count of alerts with state 'New'
	New *int32 `json:"new,omitempty"`
	// Acknowledged - Count of alerts with state 'Acknowledged'
	Acknowledged *int32 `json:"acknowledged,omitempty"`
	// Closed - Count of alerts with state 'Closed'
	Closed *int32 `json:"closed,omitempty"`
}

AlertsSummaryPropertiesSummaryByState summary of alerts by state

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI         string
	SubscriptionID  string
	MonitorService1 MonitorService
}

BaseClient is the base client for Alertsmanagement.

func New

func New(subscriptionID string, monitorService1 MonitorService) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string, monitorService1 MonitorService) 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).

type ErrorResponse

type ErrorResponse struct {
	Error *ErrorResponseBody `json:"error,omitempty"`
}

ErrorResponse an error response from the service.

type ErrorResponseBody

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"`
}

ErrorResponseBody details of error response.

type MonitorCondition

type MonitorCondition string

MonitorCondition enumerates the values for monitor condition.

const (
	// Fired ...
	Fired MonitorCondition = "Fired"
	// Resolved ...
	Resolved MonitorCondition = "Resolved"
)

func PossibleMonitorConditionValues

func PossibleMonitorConditionValues() []MonitorCondition

PossibleMonitorConditionValues returns an array of possible values for the MonitorCondition const type.

type MonitorService

type MonitorService string

MonitorService enumerates the values for monitor service.

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"
	// InfrastructureInsights ...
	InfrastructureInsights MonitorService = "Infrastructure 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"
	// Zabbix ...
	Zabbix MonitorService = "Zabbix"
)

func PossibleMonitorServiceValues

func PossibleMonitorServiceValues() []MonitorService

PossibleMonitorServiceValues returns an array of possible values for the MonitorService const type.

type Operation

type Operation struct {
	// Name - Name of the operation
	Name *string `json:"name,omitempty"`
	// Display - Properties of the operation
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation operation provided by provider

type OperationDisplay

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"`
}

OperationDisplay properties of the operation

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the alertsManagement Client

func NewOperationsClient

func NewOperationsClient(subscriptionID string, monitorService1 MonitorService) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string, monitorService1 MonitorService) 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 (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationsListPage, err error)

List list all operations available through Azure Alerts Management Resource Provider.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationsListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

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 (OperationsClient) ListSender

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.

type OperationsList

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"`
}

OperationsList lists the operations available in the AlertsManagement RP.

func (OperationsList) IsEmpty

func (ol OperationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationsListIterator

type OperationsListIterator struct {
	// contains filtered or unexported fields
}

OperationsListIterator provides access to a complete listing of Operation values.

func NewOperationsListIterator

func NewOperationsListIterator(page OperationsListPage) OperationsListIterator

Creates a new instance of the OperationsListIterator type.

func (*OperationsListIterator) Next

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 (*OperationsListIterator) NextWithContext

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 (OperationsListIterator) NotDone

func (iter OperationsListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationsListIterator) Response

func (iter OperationsListIterator) Response() OperationsList

Response returns the raw server response from the last page request.

func (OperationsListIterator) Value

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.

type OperationsListPage

type OperationsListPage struct {
	// contains filtered or unexported fields
}

OperationsListPage contains a page of Operation values.

func NewOperationsListPage

func NewOperationsListPage(cur OperationsList, getNextPage func(context.Context, OperationsList) (OperationsList, error)) OperationsListPage

Creates a new instance of the OperationsListPage type.

func (*OperationsListPage) Next

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 (*OperationsListPage) NextWithContext

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 (OperationsListPage) NotDone

func (page OperationsListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationsListPage) Response

func (page OperationsListPage) Response() OperationsList

Response returns the raw server response from the last page request.

func (OperationsListPage) Values

func (page OperationsListPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type Resource

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"`
}

Resource an azure resource object

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type Severity

type Severity string

Severity enumerates the values for severity.

const (
	// Sev0 ...
	Sev0 Severity = "Sev0"
	// Sev1 ...
	Sev1 Severity = "Sev1"
	// Sev2 ...
	Sev2 Severity = "Sev2"
	// Sev3 ...
	Sev3 Severity = "Sev3"
	// Sev4 ...
	Sev4 Severity = "Sev4"
)

func PossibleSeverityValues

func PossibleSeverityValues() []Severity

PossibleSeverityValues returns an array of possible values for the Severity const type.

type SignalType

type SignalType string

SignalType enumerates the values for signal type.

const (
	// Log ...
	Log SignalType = "Log"
	// Metric ...
	Metric SignalType = "Metric"
	// Unknown ...
	Unknown SignalType = "Unknown"
)

func PossibleSignalTypeValues

func PossibleSignalTypeValues() []SignalType

PossibleSignalTypeValues returns an array of possible values for the SignalType const type.

type SmartGroup

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"`
}

SmartGroup set of related alerts grouped together smartly by AMS.

func (SmartGroup) MarshalJSON

func (sg SmartGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SmartGroup.

func (*SmartGroup) UnmarshalJSON

func (sg *SmartGroup) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SmartGroup struct.

type SmartGroupAggregatedProperty

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"`
}

SmartGroupAggregatedProperty aggregated property of each type

type SmartGroupModification

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"`
}

SmartGroupModification alert Modification details

func (SmartGroupModification) MarshalJSON

func (sgm SmartGroupModification) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SmartGroupModification.

type SmartGroupModificationEvent

type SmartGroupModificationEvent string

SmartGroupModificationEvent enumerates the values for smart group modification event.

const (
	// SmartGroupModificationEventAlertAdded ...
	SmartGroupModificationEventAlertAdded SmartGroupModificationEvent = "AlertAdded"
	// SmartGroupModificationEventAlertRemoved ...
	SmartGroupModificationEventAlertRemoved SmartGroupModificationEvent = "AlertRemoved"
	// SmartGroupModificationEventSmartGroupCreated ...
	SmartGroupModificationEventSmartGroupCreated SmartGroupModificationEvent = "SmartGroupCreated"
	// SmartGroupModificationEventStateChange ...
	SmartGroupModificationEventStateChange SmartGroupModificationEvent = "StateChange"
)

func PossibleSmartGroupModificationEventValues

func PossibleSmartGroupModificationEventValues() []SmartGroupModificationEvent

PossibleSmartGroupModificationEventValues returns an array of possible values for the SmartGroupModificationEvent const type.

type SmartGroupModificationItem

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"`
}

SmartGroupModificationItem smartGroup modification item.

type SmartGroupModificationProperties

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"`
}

SmartGroupModificationProperties properties of the smartGroup modification item.

func (SmartGroupModificationProperties) MarshalJSON

func (sgmp SmartGroupModificationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SmartGroupModificationProperties.

type SmartGroupProperties

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"`
}

SmartGroupProperties properties of smart group.

func (SmartGroupProperties) MarshalJSON

func (sgp SmartGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SmartGroupProperties.

type SmartGroupsClient

type SmartGroupsClient struct {
	BaseClient
}

SmartGroupsClient is the alertsManagement Client

func NewSmartGroupsClient

func NewSmartGroupsClient(subscriptionID string, monitorService1 MonitorService) SmartGroupsClient

NewSmartGroupsClient creates an instance of the SmartGroupsClient client.

func NewSmartGroupsClientWithBaseURI

func NewSmartGroupsClientWithBaseURI(baseURI string, subscriptionID string, monitorService1 MonitorService) 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 (SmartGroupsClient) ChangeState

func (client SmartGroupsClient) ChangeState(ctx context.Context, smartGroupID string, newState AlertState) (result SmartGroup, err error)

ChangeState change the state from unresolved to resolved and all the alerts within the smart group will also be resolved. Parameters: smartGroupID - smart Group Id newState - filter by state

func (SmartGroupsClient) ChangeStatePreparer

func (client SmartGroupsClient) ChangeStatePreparer(ctx context.Context, smartGroupID string, newState AlertState) (*http.Request, error)

ChangeStatePreparer prepares the ChangeState request.

func (SmartGroupsClient) ChangeStateResponder

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 (SmartGroupsClient) ChangeStateSender

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 (SmartGroupsClient) GetAll

func (client SmartGroupsClient) GetAll(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorCondition MonitorCondition, severity Severity, smartGroupState AlertState, timeRange TimeRange, pageCount *int32, sortBy SmartGroupsSortByFields, sortOrder string) (result SmartGroupsList, err error)

GetAll list all the smartGroups within the specified subscription. Parameters: targetResource - filter by target resource targetResourceGroup - filter by target resource group name targetResourceType - filter by target resource type monitorCondition - filter by monitor condition which is the state of the alert at monitor service severity - filter by severity smartGroupState - filter by state timeRange - filter by time range, default value is 1 day pageCount - number of items per page, 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.

func (SmartGroupsClient) GetAllPreparer

func (client SmartGroupsClient) GetAllPreparer(ctx context.Context, targetResource string, targetResourceGroup string, targetResourceType string, monitorCondition MonitorCondition, severity Severity, smartGroupState AlertState, timeRange TimeRange, pageCount *int32, sortBy SmartGroupsSortByFields, sortOrder string) (*http.Request, error)

GetAllPreparer prepares the GetAll request.

func (SmartGroupsClient) GetAllResponder

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 (SmartGroupsClient) GetAllSender

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 (SmartGroupsClient) GetByID

func (client SmartGroupsClient) GetByID(ctx context.Context, smartGroupID string) (result SmartGroup, err error)

GetByID get details of smart group. Parameters: smartGroupID - smart Group Id

func (SmartGroupsClient) GetByIDPreparer

func (client SmartGroupsClient) GetByIDPreparer(ctx context.Context, smartGroupID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (SmartGroupsClient) GetByIDResponder

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 (SmartGroupsClient) GetByIDSender

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 (SmartGroupsClient) GetHistory

func (client SmartGroupsClient) GetHistory(ctx context.Context, smartGroupID string) (result SmartGroupModification, err error)

GetHistory get the history of the changes of smart group. Parameters: smartGroupID - smart Group Id

func (SmartGroupsClient) GetHistoryPreparer

func (client SmartGroupsClient) GetHistoryPreparer(ctx context.Context, smartGroupID string) (*http.Request, error)

GetHistoryPreparer prepares the GetHistory request.

func (SmartGroupsClient) GetHistoryResponder

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 (SmartGroupsClient) GetHistorySender

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.

type SmartGroupsList

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"`
}

SmartGroupsList list the alerts.

type SmartGroupsSortByFields

type SmartGroupsSortByFields string

SmartGroupsSortByFields enumerates the values for smart groups sort by fields.

const (
	// SmartGroupsSortByFieldsAlertsCount ...
	SmartGroupsSortByFieldsAlertsCount SmartGroupsSortByFields = "alertsCount"
	// SmartGroupsSortByFieldsLastModifiedDateTime ...
	SmartGroupsSortByFieldsLastModifiedDateTime SmartGroupsSortByFields = "lastModifiedDateTime"
	// SmartGroupsSortByFieldsSeverity ...
	SmartGroupsSortByFieldsSeverity SmartGroupsSortByFields = "severity"
	// SmartGroupsSortByFieldsStartDateTime ...
	SmartGroupsSortByFieldsStartDateTime SmartGroupsSortByFields = "startDateTime"
	// SmartGroupsSortByFieldsState ...
	SmartGroupsSortByFieldsState SmartGroupsSortByFields = "state"
)

func PossibleSmartGroupsSortByFieldsValues

func PossibleSmartGroupsSortByFieldsValues() []SmartGroupsSortByFields

PossibleSmartGroupsSortByFieldsValues returns an array of possible values for the SmartGroupsSortByFields const type.

type State

type State string

State enumerates the values for state.

const (
	// StateAcknowledged ...
	StateAcknowledged State = "Acknowledged"
	// StateClosed ...
	StateClosed State = "Closed"
	// StateNew ...
	StateNew State = "New"
)

func PossibleStateValues

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type TimeRange

type TimeRange string

TimeRange enumerates the values for time range.

const (
	// Oned ...
	Oned TimeRange = "1d"
	// Oneh ...
	Oneh TimeRange = "1h"
	// Sevend ...
	Sevend TimeRange = "7d"
	// ThreeZerod ...
	ThreeZerod TimeRange = "30d"
)

func PossibleTimeRangeValues

func PossibleTimeRangeValues() []TimeRange

PossibleTimeRangeValues returns an array of possible values for the TimeRange const type.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL