import "github.com/Azure/azure-sdk-for-go/services/alertsmanagement/mgmt/2018-05-05/alertsmanagement"
Package alertsmanagement implements the Azure ARM Alertsmanagement service API version 2018-05-05.
AlertsManagement Client
alerts.go client.go enums.go models.go operations.go smartgroups.go version.go
const (
// DefaultBaseURI is the default URI used for the service Alertsmanagement
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
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"`
}Alert an alert created in alert management service.
MarshalJSON is the custom marshaler for Alert.
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 (am AlertModification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertModification.
AlertModificationEvent enumerates the values for alert modification event.
const (
// AlertCreated ...
AlertCreated AlertModificationEvent = "AlertCreated"
// MonitorConditionChange ...
MonitorConditionChange AlertModificationEvent = "MonitorConditionChange"
// StateChange ...
StateChange AlertModificationEvent = "StateChange"
)func PossibleAlertModificationEventValues() []AlertModificationEvent
PossibleAlertModificationEventValues returns an array of possible values for the AlertModificationEvent const type.
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 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 (amp AlertModificationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertModificationProperties.
type AlertProperties struct {
Essentials *Essentials `json:"essentials,omitempty"`
Context interface{} `json:"context,omitempty"`
EgressConfig interface{} `json:"egressConfig,omitempty"`
}AlertProperties alert property bag
AlertState enumerates the values for alert state.
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.
type AlertsClient struct {
BaseClient
}AlertsClient is the alertsManagement Client
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.
ChangeStateResponder handles the response to the ChangeState request. The method always closes the http.Response Body.
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.
GetAllSender sends the GetAll request. The method will close the http.Response Body if it receives an 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.
GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.
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.
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. For example, 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.
GetSummarySender sends the GetSummary request. The method will close the http.Response Body if it receives an error.
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 (al AlertsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AlertsListIterator struct {
// contains filtered or unexported fields
}AlertsListIterator provides access to a complete listing of Alert values.
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.
type AlertsListPage struct {
// contains filtered or unexported fields
}AlertsListPage contains a page of Alert values.
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.
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() []AlertsSortByFields
PossibleAlertsSortByFieldsValues returns an array of possible values for the AlertsSortByFields const type.
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"`
}AlertsSummary summary of alerts based on the input filters and 'groupby' parameters.
func (as AlertsSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AlertsSummary.
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"`
}AlertsSummaryGroup group the result set.
AlertsSummaryGroupByFields enumerates the values for alerts summary group by fields.
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.
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"`
}AlertsSummaryGroupItem alerts summary group item
BaseClient is the base client for Alertsmanagement.
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).
type ErrorResponse struct {
Error *ErrorResponseBody `json:"error,omitempty"`
}ErrorResponse an error response from the service.
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 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; Can be 'Fired' or 'Resolved', which 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"`
}Essentials this object contains consistent fields across different monitor services.
func (e Essentials) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Essentials.
MonitorCondition enumerates the values for monitor condition.
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.
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.
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 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 struct {
BaseClient
}OperationsClient is the alertsManagement Client
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.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
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 (ol OperationsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationsListIterator struct {
// contains filtered or unexported fields
}OperationsListIterator provides access to a complete listing of Operation values.
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.
type OperationsListPage struct {
// contains filtered or unexported fields
}OperationsListPage contains a page of Operation values.
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.
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
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"
)PossibleSeverityValues returns an array of possible values for the Severity const type.
SignalType enumerates the values for signal type.
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.
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 (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.
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 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 (sgm SmartGroupModification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroupModification.
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() []SmartGroupModificationEvent
PossibleSmartGroupModificationEventValues returns an array of possible values for the SmartGroupModificationEvent const type.
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 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 (sgmp SmartGroupModificationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroupModificationProperties.
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 (sgp SmartGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SmartGroupProperties.
type SmartGroupsClient struct {
BaseClient
}SmartGroupsClient is the alertsManagement Client
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.
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.
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.
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.
GetHistorySender sends the GetHistory request. The method will close the http.Response Body if it receives an error.
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.
func (sgl SmartGroupsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type SmartGroupsListIterator struct {
// contains filtered or unexported fields
}SmartGroupsListIterator provides access to a complete listing of SmartGroup values.
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.
type SmartGroupsListPage struct {
// contains filtered or unexported fields
}SmartGroupsListPage contains a page of SmartGroup values.
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.
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.
const (
// StateAcknowledged ...
StateAcknowledged State = "Acknowledged"
// StateClosed ...
StateClosed State = "Closed"
// StateNew ...
StateNew State = "New"
)PossibleStateValues returns an array of possible values for the State const type.
TimeRange enumerates the values for time range.
const (
// Oned ...
Oned TimeRange = "1d"
// Oneh ...
Oneh TimeRange = "1h"
// Sevend ...
Sevend TimeRange = "7d"
// ThreeZerod ...
ThreeZerod TimeRange = "30d"
)PossibleTimeRangeValues returns an array of possible values for the TimeRange const type.
| Path | Synopsis |
|---|---|
| alertsmanagementapi |
Package alertsmanagement imports 9 packages (graph) and is imported by 4 packages. Updated 2021-01-16. Refresh now. Tools for package owners.