azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/alertsmanagement/mgmt/2019-05-05/alertsmanagement Index | Files | Directories

package alertsmanagement

import "github.com/Azure/azure-sdk-for-go/services/preview/alertsmanagement/mgmt/2019-05-05/alertsmanagement"

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

AlertsManagement Client

Index

Package Files

actionrules.go alerts.go client.go models.go operations.go smartgroups.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type ActionGroup Uses

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 Uses

func (ag ActionGroup) AsActionGroup() (*ActionGroup, bool)

AsActionGroup is the BasicActionRuleProperties implementation for ActionGroup.

func (ActionGroup) AsActionRuleProperties Uses

func (ag ActionGroup) AsActionRuleProperties() (*ActionRuleProperties, bool)

AsActionRuleProperties is the BasicActionRuleProperties implementation for ActionGroup.

func (ActionGroup) AsBasicActionRuleProperties Uses

func (ag ActionGroup) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)

AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for ActionGroup.

func (ActionGroup) AsDiagnostics Uses

func (ag ActionGroup) AsDiagnostics() (*Diagnostics, bool)

AsDiagnostics is the BasicActionRuleProperties implementation for ActionGroup.

func (ActionGroup) AsSuppression Uses

func (ag ActionGroup) AsSuppression() (*Suppression, bool)

AsSuppression is the BasicActionRuleProperties implementation for ActionGroup.

func (ActionGroup) MarshalJSON Uses

func (ag ActionGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ActionGroup.

type ActionRule Uses

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 Uses

func (ar ActionRule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ActionRule.

func (*ActionRule) UnmarshalJSON Uses

func (ar *ActionRule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ActionRule struct.

type ActionRuleProperties Uses

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 Uses

func (arp ActionRuleProperties) AsActionGroup() (*ActionGroup, bool)

AsActionGroup is the BasicActionRuleProperties implementation for ActionRuleProperties.

func (ActionRuleProperties) AsActionRuleProperties Uses

func (arp ActionRuleProperties) AsActionRuleProperties() (*ActionRuleProperties, bool)

AsActionRuleProperties is the BasicActionRuleProperties implementation for ActionRuleProperties.

func (ActionRuleProperties) AsBasicActionRuleProperties Uses

func (arp ActionRuleProperties) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)

AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for ActionRuleProperties.

func (ActionRuleProperties) AsDiagnostics Uses

func (arp ActionRuleProperties) AsDiagnostics() (*Diagnostics, bool)

AsDiagnostics is the BasicActionRuleProperties implementation for ActionRuleProperties.

func (ActionRuleProperties) AsSuppression Uses

func (arp ActionRuleProperties) AsSuppression() (*Suppression, bool)

AsSuppression is the BasicActionRuleProperties implementation for ActionRuleProperties.

func (ActionRuleProperties) MarshalJSON Uses

func (arp ActionRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ActionRuleProperties.

type ActionRuleStatus Uses

type ActionRuleStatus string

ActionRuleStatus enumerates the values for action rule status.

const (
    // Disabled ...
    Disabled ActionRuleStatus = "Disabled"
    // Enabled ...
    Enabled ActionRuleStatus = "Enabled"
)

func PossibleActionRuleStatusValues Uses

func PossibleActionRuleStatusValues() []ActionRuleStatus

PossibleActionRuleStatusValues returns an array of possible values for the ActionRuleStatus const type.

type ActionRulesClient Uses

type ActionRulesClient struct {
    BaseClient
}

ActionRulesClient is the alertsManagement Client

func NewActionRulesClient Uses

func NewActionRulesClient(subscriptionID string) ActionRulesClient

NewActionRulesClient creates an instance of the ActionRulesClient client.

func NewActionRulesClientWithBaseURI Uses

func NewActionRulesClientWithBaseURI(baseURI string, subscriptionID string) ActionRulesClient

NewActionRulesClientWithBaseURI creates an instance of the ActionRulesClient client.

func (ActionRulesClient) CreateUpdate Uses

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 Uses

func (client ActionRulesClient) CreateUpdatePreparer(ctx context.Context, resourceGroupName string, actionRuleName string, actionRule ActionRule) (*http.Request, error)

CreateUpdatePreparer prepares the CreateUpdate request.

func (ActionRulesClient) CreateUpdateResponder Uses

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 Uses

func (client ActionRulesClient) CreateUpdateSender(req *http.Request) (*http.Response, error)

CreateUpdateSender sends the CreateUpdate request. The method will close the http.Response Body if it receives an error.

func (ActionRulesClient) Delete Uses

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 Uses

func (client ActionRulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, actionRuleName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ActionRulesClient) DeleteResponder Uses

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 Uses

func (client ActionRulesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ActionRulesClient) GetByName Uses

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 Uses

func (client ActionRulesClient) GetByNamePreparer(ctx context.Context, resourceGroupName string, actionRuleName string) (*http.Request, error)

GetByNamePreparer prepares the GetByName request.

func (ActionRulesClient) GetByNameResponder Uses

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 Uses

func (client ActionRulesClient) GetByNameSender(req *http.Request) (*http.Response, error)

GetByNameSender sends the GetByName request. The method will close the http.Response Body if it receives an error.

func (ActionRulesClient) ListByResourceGroup Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (client ActionRulesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (ActionRulesClient) Update Uses

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 Uses

func (client ActionRulesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, actionRuleName string, actionRulePatch PatchObject) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ActionRulesClient) UpdateResponder Uses

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 Uses

func (client ActionRulesClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ActionRulesList Uses

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 Uses

func (arl ActionRulesList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ActionRulesListIterator Uses

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

ActionRulesListIterator provides access to a complete listing of ActionRule values.

func NewActionRulesListIterator Uses

func NewActionRulesListIterator(page ActionRulesListPage) ActionRulesListIterator

Creates a new instance of the ActionRulesListIterator type.

func (*ActionRulesListIterator) Next Uses

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 Uses

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 Uses

func (iter ActionRulesListIterator) NotDone() bool

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

func (ActionRulesListIterator) Response Uses

func (iter ActionRulesListIterator) Response() ActionRulesList

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

func (ActionRulesListIterator) Value Uses

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 Uses

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

ActionRulesListPage contains a page of ActionRule values.

func NewActionRulesListPage Uses

func NewActionRulesListPage(getNextPage func(context.Context, ActionRulesList) (ActionRulesList, error)) ActionRulesListPage

Creates a new instance of the ActionRulesListPage type.

func (*ActionRulesListPage) Next Uses

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 Uses

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 Uses

func (page ActionRulesListPage) NotDone() bool

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

func (ActionRulesListPage) Response Uses

func (page ActionRulesListPage) Response() ActionRulesList

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

func (ActionRulesListPage) Values Uses

func (page ActionRulesListPage) Values() []ActionRule

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

type Alert Uses

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.

type AlertModification Uses

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

type AlertModificationEvent Uses

type AlertModificationEvent string

AlertModificationEvent enumerates the values for alert modification event.

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

func PossibleAlertModificationEventValues Uses

func PossibleAlertModificationEventValues() []AlertModificationEvent

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

type AlertModificationItem Uses

type AlertModificationItem struct {
    // ModificationEvent - Reason for the modification. Possible values include: 'AlertCreated', 'StateChange', 'MonitorConditionChange'
    ModificationEvent AlertModificationEvent `json:"modificationEvent,omitempty"`
    // OldValue - Old value
    OldValue *string `json:"oldValue,omitempty"`
    // NewValue - New value
    NewValue *string `json:"newValue,omitempty"`
    // ModifiedAt - Modified date and time
    ModifiedAt *string `json:"modifiedAt,omitempty"`
    // ModifiedBy - Modified user details (Principal client name)
    ModifiedBy *string `json:"modifiedBy,omitempty"`
    // Comments - Modification comments
    Comments *string `json:"comments,omitempty"`
    // Description - Description of the modification
    Description *string `json:"description,omitempty"`
}

AlertModificationItem alert modification item.

type AlertModificationProperties Uses

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.

type AlertProperties Uses

type AlertProperties struct {
    Essentials   *Essentials `json:"essentials,omitempty"`
    Context      interface{} `json:"context,omitempty"`
    EgressConfig interface{} `json:"egressConfig,omitempty"`
}

AlertProperties alert property bag

type AlertState Uses

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 Uses

func PossibleAlertStateValues() []AlertState

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

type AlertsClient Uses

type AlertsClient struct {
    BaseClient
}

AlertsClient is the alertsManagement Client

func NewAlertsClient Uses

func NewAlertsClient(subscriptionID string) AlertsClient

NewAlertsClient creates an instance of the AlertsClient client.

func NewAlertsClientWithBaseURI Uses

func NewAlertsClientWithBaseURI(baseURI string, subscriptionID string) AlertsClient

NewAlertsClientWithBaseURI creates an instance of the AlertsClient client.

func (AlertsClient) ChangeState Uses

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 Uses

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

ChangeStatePreparer prepares the ChangeState request.

func (AlertsClient) ChangeStateResponder Uses

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 Uses

func (client AlertsClient) ChangeStateSender(req *http.Request) (*http.Response, error)

ChangeStateSender sends the ChangeState request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) GetAll Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (client AlertsClient) GetAllSender(req *http.Request) (*http.Response, error)

GetAllSender sends the GetAll request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) GetByID Uses

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

GetByID get information related to a specific alert Parameters: alertID - unique ID of an alert instance.

func (AlertsClient) GetByIDPreparer Uses

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

GetByIDPreparer prepares the GetByID request.

func (AlertsClient) GetByIDResponder Uses

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 Uses

func (client AlertsClient) GetByIDSender(req *http.Request) (*http.Response, error)

GetByIDSender sends the GetByID request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) GetHistory Uses

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 Uses

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

GetHistoryPreparer prepares the GetHistory request.

func (AlertsClient) GetHistoryResponder Uses

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 Uses

func (client AlertsClient) GetHistorySender(req *http.Request) (*http.Response, error)

GetHistorySender sends the GetHistory request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) GetSummary Uses

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 Uses

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 Uses

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 Uses

func (client AlertsClient) GetSummarySender(req *http.Request) (*http.Response, error)

GetSummarySender sends the GetSummary request. The method will close the http.Response Body if it receives an error.

func (AlertsClient) MetaData Uses

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 Uses

func (client AlertsClient) MetaDataPreparer(ctx context.Context) (*http.Request, error)

MetaDataPreparer prepares the MetaData request.

func (AlertsClient) MetaDataResponder Uses

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 Uses

func (client AlertsClient) MetaDataSender(req *http.Request) (*http.Response, error)

MetaDataSender sends the MetaData request. The method will close the http.Response Body if it receives an error.

type AlertsList Uses

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 Uses

func (al AlertsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AlertsListIterator Uses

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

AlertsListIterator provides access to a complete listing of Alert values.

func NewAlertsListIterator Uses

func NewAlertsListIterator(page AlertsListPage) AlertsListIterator

Creates a new instance of the AlertsListIterator type.

func (*AlertsListIterator) Next Uses

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 Uses

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 Uses

func (iter AlertsListIterator) NotDone() bool

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

func (AlertsListIterator) Response Uses

func (iter AlertsListIterator) Response() AlertsList

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

func (AlertsListIterator) Value Uses

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 Uses

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

AlertsListPage contains a page of Alert values.

func NewAlertsListPage Uses

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

Creates a new instance of the AlertsListPage type.

func (*AlertsListPage) Next Uses

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 Uses

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 Uses

func (page AlertsListPage) NotDone() bool

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

func (AlertsListPage) Response Uses

func (page AlertsListPage) Response() AlertsList

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

func (AlertsListPage) Values Uses

func (page AlertsListPage) Values() []Alert

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

type AlertsMetaData Uses

type AlertsMetaData struct {
    autorest.Response `json:"-"`
    Properties        BasicAlertsMetaDataProperties `json:"properties,omitempty"`
}

AlertsMetaData alert meta data information.

func (*AlertsMetaData) UnmarshalJSON Uses

func (amd *AlertsMetaData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AlertsMetaData struct.

type AlertsMetaDataProperties Uses

type AlertsMetaDataProperties struct {
    // MetadataIdentifier - Possible values include: 'MetadataIdentifierAlertsMetaDataProperties', 'MetadataIdentifierMonitorServiceList'
    MetadataIdentifier MetadataIdentifier `json:"metadataIdentifier,omitempty"`
}

AlertsMetaDataProperties alert meta data property bag

func (AlertsMetaDataProperties) AsAlertsMetaDataProperties Uses

func (amdp AlertsMetaDataProperties) AsAlertsMetaDataProperties() (*AlertsMetaDataProperties, bool)

AsAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for AlertsMetaDataProperties.

func (AlertsMetaDataProperties) AsBasicAlertsMetaDataProperties Uses

func (amdp AlertsMetaDataProperties) AsBasicAlertsMetaDataProperties() (BasicAlertsMetaDataProperties, bool)

AsBasicAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for AlertsMetaDataProperties.

func (AlertsMetaDataProperties) AsMonitorServiceList Uses

func (amdp AlertsMetaDataProperties) AsMonitorServiceList() (*MonitorServiceList, bool)

AsMonitorServiceList is the BasicAlertsMetaDataProperties implementation for AlertsMetaDataProperties.

func (AlertsMetaDataProperties) MarshalJSON Uses

func (amdp AlertsMetaDataProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AlertsMetaDataProperties.

type AlertsSortByFields Uses

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 Uses

func PossibleAlertsSortByFieldsValues() []AlertsSortByFields

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

type AlertsSummary Uses

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.

type AlertsSummaryGroup Uses

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 Uses

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 Uses

func PossibleAlertsSummaryGroupByFieldsValues() []AlertsSummaryGroupByFields

PossibleAlertsSummaryGroupByFieldsValues returns an array of possible values for the AlertsSummaryGroupByFields const type.

type AlertsSummaryGroupItem Uses

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 BaseClient Uses

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

BaseClient is the base client for Alertsmanagement.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BasicActionRuleProperties Uses

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 Uses

type BasicAlertsMetaDataProperties interface {
    AsMonitorServiceList() (*MonitorServiceList, bool)
    AsAlertsMetaDataProperties() (*AlertsMetaDataProperties, bool)
}

BasicAlertsMetaDataProperties alert meta data property bag

type Bool Uses

type Bool struct {
    autorest.Response `json:"-"`
    Value             *bool `json:"value,omitempty"`
}

Bool ...

type Condition Uses

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 Uses

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 Diagnostics Uses

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 Uses

func (d Diagnostics) AsActionGroup() (*ActionGroup, bool)

AsActionGroup is the BasicActionRuleProperties implementation for Diagnostics.

func (Diagnostics) AsActionRuleProperties Uses

func (d Diagnostics) AsActionRuleProperties() (*ActionRuleProperties, bool)

AsActionRuleProperties is the BasicActionRuleProperties implementation for Diagnostics.

func (Diagnostics) AsBasicActionRuleProperties Uses

func (d Diagnostics) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)

AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for Diagnostics.

func (Diagnostics) AsDiagnostics Uses

func (d Diagnostics) AsDiagnostics() (*Diagnostics, bool)

AsDiagnostics is the BasicActionRuleProperties implementation for Diagnostics.

func (Diagnostics) AsSuppression Uses

func (d Diagnostics) AsSuppression() (*Suppression, bool)

AsSuppression is the BasicActionRuleProperties implementation for Diagnostics.

func (Diagnostics) MarshalJSON Uses

func (d Diagnostics) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Diagnostics.

type ErrorResponse Uses

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

ErrorResponse an error response from the service.

type ErrorResponseBody Uses

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 Uses

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.

type ManagedResource Uses

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 Uses

func (mr ManagedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedResource.

type MetadataIdentifier Uses

type MetadataIdentifier string

MetadataIdentifier enumerates the values for metadata identifier.

const (
    // MetadataIdentifierAlertsMetaDataProperties ...
    MetadataIdentifierAlertsMetaDataProperties MetadataIdentifier = "alertsMetaDataProperties"
    // MetadataIdentifierMonitorServiceList ...
    MetadataIdentifierMonitorServiceList MetadataIdentifier = "MonitorServiceList"
)

func PossibleMetadataIdentifierValues Uses

func PossibleMetadataIdentifierValues() []MetadataIdentifier

PossibleMetadataIdentifierValues returns an array of possible values for the MetadataIdentifier const type.

type MonitorCondition Uses

type MonitorCondition string

MonitorCondition enumerates the values for monitor condition.

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

func PossibleMonitorConditionValues Uses

func PossibleMonitorConditionValues() []MonitorCondition

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

type MonitorService Uses

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 Uses

func PossibleMonitorServiceValues() []MonitorService

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

type MonitorServiceDetails Uses

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 Uses

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 Uses

func (msl MonitorServiceList) AsAlertsMetaDataProperties() (*AlertsMetaDataProperties, bool)

AsAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for MonitorServiceList.

func (MonitorServiceList) AsBasicAlertsMetaDataProperties Uses

func (msl MonitorServiceList) AsBasicAlertsMetaDataProperties() (BasicAlertsMetaDataProperties, bool)

AsBasicAlertsMetaDataProperties is the BasicAlertsMetaDataProperties implementation for MonitorServiceList.

func (MonitorServiceList) AsMonitorServiceList Uses

func (msl MonitorServiceList) AsMonitorServiceList() (*MonitorServiceList, bool)

AsMonitorServiceList is the BasicAlertsMetaDataProperties implementation for MonitorServiceList.

func (MonitorServiceList) MarshalJSON Uses

func (msl MonitorServiceList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MonitorServiceList.

type Operation Uses

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 Uses

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 Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the alertsManagement Client

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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 Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OperationsList Uses

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 Uses

func (ol OperationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationsListIterator Uses

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

OperationsListIterator provides access to a complete listing of Operation values.

func NewOperationsListIterator Uses

func NewOperationsListIterator(page OperationsListPage) OperationsListIterator

Creates a new instance of the OperationsListIterator type.

func (*OperationsListIterator) Next Uses

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 Uses

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 Uses

func (iter OperationsListIterator) NotDone() bool

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

func (OperationsListIterator) Response Uses

func (iter OperationsListIterator) Response() OperationsList

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

func (OperationsListIterator) Value Uses

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 Uses

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

OperationsListPage contains a page of Operation values.

func NewOperationsListPage Uses

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

Creates a new instance of the OperationsListPage type.

func (*OperationsListPage) Next Uses

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 Uses

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 Uses

func (page OperationsListPage) NotDone() bool

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

func (OperationsListPage) Response Uses

func (page OperationsListPage) Response() OperationsList

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

func (OperationsListPage) Values Uses

func (page OperationsListPage) Values() []Operation

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

type Operator Uses

type Operator string

Operator enumerates the values for operator.

const (
    // Contains ...
    Contains Operator = "Contains"
    // DoesNotContain ...
    DoesNotContain Operator = "DoesNotContain"
    // Equals ...
    Equals Operator = "Equals"
    // NotEquals ...
    NotEquals Operator = "NotEquals"
)

func PossibleOperatorValues Uses

func PossibleOperatorValues() []Operator

PossibleOperatorValues returns an array of possible values for the Operator const type.

type PatchObject Uses

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 Uses

func (po PatchObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PatchObject.

func (*PatchObject) UnmarshalJSON Uses

func (po *PatchObject) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PatchObject struct.

type PatchProperties Uses

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 Uses

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 Uses

type Scope struct {
    // ScopeType - type of target scope. Possible values include: 'ScopeTypeResourceGroup', 'ScopeTypeResource'
    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 Uses

type ScopeType string

ScopeType enumerates the values for scope type.

const (
    // ScopeTypeResource ...
    ScopeTypeResource ScopeType = "Resource"
    // ScopeTypeResourceGroup ...
    ScopeTypeResourceGroup ScopeType = "ResourceGroup"
)

func PossibleScopeTypeValues Uses

func PossibleScopeTypeValues() []ScopeType

PossibleScopeTypeValues returns an array of possible values for the ScopeType const type.

type Severity Uses

type Severity string

Severity enumerates the values for severity.

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

func PossibleSeverityValues Uses

func PossibleSeverityValues() []Severity

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

type SignalType Uses

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 Uses

func PossibleSignalTypeValues() []SignalType

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

type SmartGroup Uses

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 Uses

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

MarshalJSON is the custom marshaler for SmartGroup.

func (*SmartGroup) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for SmartGroup struct.

type SmartGroupAggregatedProperty Uses

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 Uses

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

type SmartGroupModificationEvent Uses

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 Uses

func PossibleSmartGroupModificationEventValues() []SmartGroupModificationEvent

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

type SmartGroupModificationItem Uses

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 Uses

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.

type SmartGroupProperties Uses

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.

type SmartGroupsClient Uses

type SmartGroupsClient struct {
    BaseClient
}

SmartGroupsClient is the alertsManagement Client

func NewSmartGroupsClient Uses

func NewSmartGroupsClient(subscriptionID string) SmartGroupsClient

NewSmartGroupsClient creates an instance of the SmartGroupsClient client.

func NewSmartGroupsClientWithBaseURI Uses

func NewSmartGroupsClientWithBaseURI(baseURI string, subscriptionID string) SmartGroupsClient

NewSmartGroupsClientWithBaseURI creates an instance of the SmartGroupsClient client.

func (SmartGroupsClient) ChangeState Uses

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 Uses

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

ChangeStatePreparer prepares the ChangeState request.

func (SmartGroupsClient) ChangeStateResponder Uses

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 Uses

func (client SmartGroupsClient) ChangeStateSender(req *http.Request) (*http.Response, error)

ChangeStateSender sends the ChangeState request. The method will close the http.Response Body if it receives an error.

func (SmartGroupsClient) GetAll Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (client SmartGroupsClient) GetAllSender(req *http.Request) (*http.Response, error)

GetAllSender sends the GetAll request. The method will close the http.Response Body if it receives an error.

func (SmartGroupsClient) GetByID Uses

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 Uses

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

GetByIDPreparer prepares the GetByID request.

func (SmartGroupsClient) GetByIDResponder Uses

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 Uses

func (client SmartGroupsClient) GetByIDSender(req *http.Request) (*http.Response, error)

GetByIDSender sends the GetByID request. The method will close the http.Response Body if it receives an error.

func (SmartGroupsClient) GetHistory Uses

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 Uses

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

GetHistoryPreparer prepares the GetHistory request.

func (SmartGroupsClient) GetHistoryResponder Uses

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 Uses

func (client SmartGroupsClient) GetHistorySender(req *http.Request) (*http.Response, error)

GetHistorySender sends the GetHistory request. The method will close the http.Response Body if it receives an error.

type SmartGroupsList Uses

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 Uses

func (sgl SmartGroupsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SmartGroupsListIterator Uses

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

SmartGroupsListIterator provides access to a complete listing of SmartGroup values.

func NewSmartGroupsListIterator Uses

func NewSmartGroupsListIterator(page SmartGroupsListPage) SmartGroupsListIterator

Creates a new instance of the SmartGroupsListIterator type.

func (*SmartGroupsListIterator) Next Uses

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 Uses

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 Uses

func (iter SmartGroupsListIterator) NotDone() bool

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

func (SmartGroupsListIterator) Response Uses

func (iter SmartGroupsListIterator) Response() SmartGroupsList

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

func (SmartGroupsListIterator) Value Uses

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 Uses

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

SmartGroupsListPage contains a page of SmartGroup values.

func NewSmartGroupsListPage Uses

func NewSmartGroupsListPage(getNextPage func(context.Context, SmartGroupsList) (SmartGroupsList, error)) SmartGroupsListPage

Creates a new instance of the SmartGroupsListPage type.

func (*SmartGroupsListPage) Next Uses

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 Uses

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 Uses

func (page SmartGroupsListPage) NotDone() bool

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

func (SmartGroupsListPage) Response Uses

func (page SmartGroupsListPage) Response() SmartGroupsList

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

func (SmartGroupsListPage) Values Uses

func (page SmartGroupsListPage) Values() []SmartGroup

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

type SmartGroupsSortByFields Uses

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 Uses

func PossibleSmartGroupsSortByFieldsValues() []SmartGroupsSortByFields

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

type State Uses

type State string

State enumerates the values for state.

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

func PossibleStateValues Uses

func PossibleStateValues() []State

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

type Suppression Uses

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 Uses

func (s Suppression) AsActionGroup() (*ActionGroup, bool)

AsActionGroup is the BasicActionRuleProperties implementation for Suppression.

func (Suppression) AsActionRuleProperties Uses

func (s Suppression) AsActionRuleProperties() (*ActionRuleProperties, bool)

AsActionRuleProperties is the BasicActionRuleProperties implementation for Suppression.

func (Suppression) AsBasicActionRuleProperties Uses

func (s Suppression) AsBasicActionRuleProperties() (BasicActionRuleProperties, bool)

AsBasicActionRuleProperties is the BasicActionRuleProperties implementation for Suppression.

func (Suppression) AsDiagnostics Uses

func (s Suppression) AsDiagnostics() (*Diagnostics, bool)

AsDiagnostics is the BasicActionRuleProperties implementation for Suppression.

func (Suppression) AsSuppression Uses

func (s Suppression) AsSuppression() (*Suppression, bool)

AsSuppression is the BasicActionRuleProperties implementation for Suppression.

func (Suppression) MarshalJSON Uses

func (s Suppression) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Suppression.

type SuppressionConfig Uses

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 Uses

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 Uses

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 Uses

func PossibleSuppressionTypeValues() []SuppressionType

PossibleSuppressionTypeValues returns an array of possible values for the SuppressionType const type.

type TimeRange Uses

type TimeRange string

TimeRange enumerates the values for time range.

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

func PossibleTimeRangeValues Uses

func PossibleTimeRangeValues() []TimeRange

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

type Type Uses

type Type string

Type enumerates the values for type.

const (
    // TypeActionGroup ...
    TypeActionGroup Type = "ActionGroup"
    // TypeActionRuleProperties ...
    TypeActionRuleProperties Type = "ActionRuleProperties"
    // TypeDiagnostics ...
    TypeDiagnostics Type = "Diagnostics"
    // TypeSuppression ...
    TypeSuppression Type = "Suppression"
)

func PossibleTypeValues Uses

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

Directories

PathSynopsis
alertsmanagementapi

Package alertsmanagement imports 10 packages (graph) and is imported by 3 packages. Updated 2019-09-03. Refresh now. Tools for package owners.