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