README
¶
github.com/hashicorp/go-azure-sdk/resource-manager/insights/2016-03-01/alertruleincidents Documentation
The alertruleincidents SDK allows for interaction with the Azure Resource Manager Service insights (API Version 2016-03-01).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/insights/2016-03-01/alertruleincidents"
Client Initialization
client := alertruleincidents.NewAlertRuleIncidentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AlertRuleIncidentsClient.Get
ctx := context.TODO()
id := alertruleincidents.NewIncidentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "alertRuleValue", "incidentValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AlertRuleIncidentsClient.ListByAlertRule
ctx := context.TODO()
id := alertruleincidents.NewAlertRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "alertRuleValue")
read, err := client.ListByAlertRule(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation
¶
Index ¶
- func ValidateAlertRuleID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateIncidentID(input interface{}, key string) (warnings []string, errors []error)
- type AlertRuleId
- type AlertRuleIncidentsClient
- type GetOperationResponse
- type Incident
- type IncidentId
- type IncidentListResult
- type ListByAlertRuleOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateAlertRuleID ¶
ValidateAlertRuleID checks that 'input' can be parsed as a Alert Rule ID
func ValidateIncidentID ¶
ValidateIncidentID checks that 'input' can be parsed as a Incident ID
Types ¶
type AlertRuleId ¶
AlertRuleId is a struct representing the Resource ID for a Alert Rule
func NewAlertRuleID ¶
func NewAlertRuleID(subscriptionId string, resourceGroupName string, alertRuleName string) AlertRuleId
NewAlertRuleID returns a new AlertRuleId struct
func ParseAlertRuleID ¶
func ParseAlertRuleID(input string) (*AlertRuleId, error)
ParseAlertRuleID parses 'input' into a AlertRuleId
func ParseAlertRuleIDInsensitively ¶
func ParseAlertRuleIDInsensitively(input string) (*AlertRuleId, error)
ParseAlertRuleIDInsensitively parses 'input' case-insensitively into a AlertRuleId note: this method should only be used for API response data and not user input
func (*AlertRuleId) FromParseResult ¶
func (id *AlertRuleId) FromParseResult(input resourceids.ParseResult) error
func (AlertRuleId) Segments ¶
func (id AlertRuleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Alert Rule ID
func (AlertRuleId) String ¶
func (id AlertRuleId) String() string
String returns a human-readable description of this Alert Rule ID
type AlertRuleIncidentsClient ¶
type AlertRuleIncidentsClient struct {
Client *resourcemanager.Client
}
func NewAlertRuleIncidentsClientWithBaseURI ¶
func NewAlertRuleIncidentsClientWithBaseURI(sdkApi sdkEnv.Api) (*AlertRuleIncidentsClient, error)
func (AlertRuleIncidentsClient) Get ¶
func (c AlertRuleIncidentsClient) Get(ctx context.Context, id IncidentId) (result GetOperationResponse, err error)
Get ...
func (AlertRuleIncidentsClient) ListByAlertRule ¶
func (c AlertRuleIncidentsClient) ListByAlertRule(ctx context.Context, id AlertRuleId) (result ListByAlertRuleOperationResponse, err error)
ListByAlertRule ...
type GetOperationResponse ¶
type Incident ¶
type Incident struct {
ActivatedTime *string `json:"activatedTime,omitempty"`
IsActive *bool `json:"isActive,omitempty"`
Name *string `json:"name,omitempty"`
ResolvedTime *string `json:"resolvedTime,omitempty"`
RuleName *string `json:"ruleName,omitempty"`
}
func (*Incident) GetActivatedTimeAsTime ¶
func (*Incident) GetResolvedTimeAsTime ¶
func (*Incident) SetActivatedTimeAsTime ¶
func (*Incident) SetResolvedTimeAsTime ¶
type IncidentId ¶
type IncidentId struct {
SubscriptionId string
ResourceGroupName string
AlertRuleName string
IncidentName string
}
IncidentId is a struct representing the Resource ID for a Incident
func NewIncidentID ¶
func NewIncidentID(subscriptionId string, resourceGroupName string, alertRuleName string, incidentName string) IncidentId
NewIncidentID returns a new IncidentId struct
func ParseIncidentID ¶
func ParseIncidentID(input string) (*IncidentId, error)
ParseIncidentID parses 'input' into a IncidentId
func ParseIncidentIDInsensitively ¶
func ParseIncidentIDInsensitively(input string) (*IncidentId, error)
ParseIncidentIDInsensitively parses 'input' case-insensitively into a IncidentId note: this method should only be used for API response data and not user input
func (*IncidentId) FromParseResult ¶
func (id *IncidentId) FromParseResult(input resourceids.ParseResult) error
func (IncidentId) Segments ¶
func (id IncidentId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Incident ID
func (IncidentId) String ¶
func (id IncidentId) String() string
String returns a human-readable description of this Incident ID
type IncidentListResult ¶
type IncidentListResult struct {
Value *[]Incident `json:"value,omitempty"`
}
type ListByAlertRuleOperationResponse ¶
type ListByAlertRuleOperationResponse struct {
HttpResponse *http.Response
OData *odata.OData
Model *IncidentListResult
}
Source Files