activitylogalertsapis

package
v0.20240920.1135249 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2020-10-01/activitylogalertsapis Documentation

The activitylogalertsapis SDK allows for interaction with Azure Resource Manager insights (API Version 2020-10-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/insights/2020-10-01/activitylogalertsapis"

Client Initialization

client := activitylogalertsapis.NewActivityLogAlertsAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ActivityLogAlertsAPIsClient.ActivityLogAlertsCreateOrUpdate

ctx := context.TODO()
id := activitylogalertsapis.NewActivityLogAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "activityLogAlertName")

payload := activitylogalertsapis.ActivityLogAlertResource{
	// ...
}


read, err := client.ActivityLogAlertsCreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ActivityLogAlertsAPIsClient.ActivityLogAlertsDelete

ctx := context.TODO()
id := activitylogalertsapis.NewActivityLogAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "activityLogAlertName")

read, err := client.ActivityLogAlertsDelete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ActivityLogAlertsAPIsClient.ActivityLogAlertsGet

ctx := context.TODO()
id := activitylogalertsapis.NewActivityLogAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "activityLogAlertName")

read, err := client.ActivityLogAlertsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ActivityLogAlertsAPIsClient.ActivityLogAlertsListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ActivityLogAlertsListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ActivityLogAlertsListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ActivityLogAlertsAPIsClient.ActivityLogAlertsListBySubscriptionId

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ActivityLogAlertsListBySubscriptionId(ctx, id)` can be used to do batched pagination
items, err := client.ActivityLogAlertsListBySubscriptionIdComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ActivityLogAlertsAPIsClient.ActivityLogAlertsUpdate

ctx := context.TODO()
id := activitylogalertsapis.NewActivityLogAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "activityLogAlertName")

payload := activitylogalertsapis.AlertRulePatchObject{
	// ...
}


read, err := client.ActivityLogAlertsUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateActivityLogAlertID 

func ValidateActivityLogAlertID(input interface{}, key string) (warnings []string, errors []error)

ValidateActivityLogAlertID checks that 'input' can be parsed as a Activity Log Alert ID

Types

type ActionGroup 

type ActionGroup struct {
	ActionGroupId     string             `json:"actionGroupId"`
	WebhookProperties *map[string]string `json:"webhookProperties,omitempty"`
}

type ActionList 

type ActionList struct {
	ActionGroups *[]ActionGroup `json:"actionGroups,omitempty"`
}

type ActivityLogAlertId 

type ActivityLogAlertId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ActivityLogAlertName string
}

ActivityLogAlertId is a struct representing the Resource ID for a Activity Log Alert

func NewActivityLogAlertID 

func NewActivityLogAlertID(subscriptionId string, resourceGroupName string, activityLogAlertName string) ActivityLogAlertId

NewActivityLogAlertID returns a new ActivityLogAlertId struct

func ParseActivityLogAlertID 

func ParseActivityLogAlertID(input string) (*ActivityLogAlertId, error)

ParseActivityLogAlertID parses 'input' into a ActivityLogAlertId

func ParseActivityLogAlertIDInsensitively 

func ParseActivityLogAlertIDInsensitively(input string) (*ActivityLogAlertId, error)

ParseActivityLogAlertIDInsensitively parses 'input' case-insensitively into a ActivityLogAlertId note: this method should only be used for API response data and not user input

func (*ActivityLogAlertId) FromParseResult 

func (id *ActivityLogAlertId) FromParseResult(input resourceids.ParseResult) error

func (ActivityLogAlertId) ID 

func (id ActivityLogAlertId) ID() string

ID returns the formatted Activity Log Alert ID

func (ActivityLogAlertId) Segments 

func (id ActivityLogAlertId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Activity Log Alert ID

func (ActivityLogAlertId) String 

func (id ActivityLogAlertId) String() string

String returns a human-readable description of this Activity Log Alert ID

type ActivityLogAlertResource 

type ActivityLogAlertResource struct {
	Id         *string              `json:"id,omitempty"`
	Location   *string              `json:"location,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *AlertRuleProperties `json:"properties,omitempty"`
	Tags       *map[string]string   `json:"tags,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type ActivityLogAlertResourceOperationPredicate 

type ActivityLogAlertResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ActivityLogAlertResourceOperationPredicate) Matches 

func (p ActivityLogAlertResourceOperationPredicate) Matches(input ActivityLogAlertResource) bool

type ActivityLogAlertsAPIsClient 

type ActivityLogAlertsAPIsClient struct {
	Client *resourcemanager.Client
}

func NewActivityLogAlertsAPIsClientWithBaseURI 

func NewActivityLogAlertsAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*ActivityLogAlertsAPIsClient, error)

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsCreateOrUpdate 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsCreateOrUpdate(ctx context.Context, id ActivityLogAlertId, input ActivityLogAlertResource) (result ActivityLogAlertsCreateOrUpdateOperationResponse, err error)

ActivityLogAlertsCreateOrUpdate ...

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsDelete 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsDelete(ctx context.Context, id ActivityLogAlertId) (result ActivityLogAlertsDeleteOperationResponse, err error)

ActivityLogAlertsDelete ...

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsGet 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsGet(ctx context.Context, id ActivityLogAlertId) (result ActivityLogAlertsGetOperationResponse, err error)

ActivityLogAlertsGet ...

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsListByResourceGroup 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ActivityLogAlertsListByResourceGroupOperationResponse, err error)

ActivityLogAlertsListByResourceGroup ...

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsListByResourceGroupComplete 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ActivityLogAlertsListByResourceGroupCompleteResult, error)

ActivityLogAlertsListByResourceGroupComplete retrieves all the results into a single object

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsListByResourceGroupCompleteMatchingPredicate 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ActivityLogAlertResourceOperationPredicate) (result ActivityLogAlertsListByResourceGroupCompleteResult, err error)

ActivityLogAlertsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsListBySubscriptionId 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsListBySubscriptionId(ctx context.Context, id commonids.SubscriptionId) (result ActivityLogAlertsListBySubscriptionIdOperationResponse, err error)

ActivityLogAlertsListBySubscriptionId ...

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsListBySubscriptionIdComplete 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsListBySubscriptionIdComplete(ctx context.Context, id commonids.SubscriptionId) (ActivityLogAlertsListBySubscriptionIdCompleteResult, error)

ActivityLogAlertsListBySubscriptionIdComplete retrieves all the results into a single object

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsListBySubscriptionIdCompleteMatchingPredicate 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsListBySubscriptionIdCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ActivityLogAlertResourceOperationPredicate) (result ActivityLogAlertsListBySubscriptionIdCompleteResult, err error)

ActivityLogAlertsListBySubscriptionIdCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ActivityLogAlertsAPIsClient) ActivityLogAlertsUpdate 

func (c ActivityLogAlertsAPIsClient) ActivityLogAlertsUpdate(ctx context.Context, id ActivityLogAlertId, input AlertRulePatchObject) (result ActivityLogAlertsUpdateOperationResponse, err error)

ActivityLogAlertsUpdate ...

type ActivityLogAlertsCreateOrUpdateOperationResponse 

type ActivityLogAlertsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActivityLogAlertResource
}

type ActivityLogAlertsDeleteOperationResponse 

type ActivityLogAlertsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ActivityLogAlertsGetOperationResponse 

type ActivityLogAlertsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActivityLogAlertResource
}

type ActivityLogAlertsListByResourceGroupCompleteResult 

type ActivityLogAlertsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ActivityLogAlertResource
}

type ActivityLogAlertsListByResourceGroupCustomPager added in v0.20240628.1153531 

type ActivityLogAlertsListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ActivityLogAlertsListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ActivityLogAlertsListByResourceGroupOperationResponse 

type ActivityLogAlertsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ActivityLogAlertResource
}

type ActivityLogAlertsListBySubscriptionIdCompleteResult 

type ActivityLogAlertsListBySubscriptionIdCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ActivityLogAlertResource
}

type ActivityLogAlertsListBySubscriptionIdCustomPager added in v0.20240628.1153531 

type ActivityLogAlertsListBySubscriptionIdCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ActivityLogAlertsListBySubscriptionIdCustomPager) NextPageLink() *odata.Link

type ActivityLogAlertsListBySubscriptionIdOperationResponse 

type ActivityLogAlertsListBySubscriptionIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ActivityLogAlertResource
}

type ActivityLogAlertsUpdateOperationResponse 

type ActivityLogAlertsUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActivityLogAlertResource
}

type AlertRuleAllOfCondition 

type AlertRuleAllOfCondition struct {
	AllOf []AlertRuleAnyOfOrLeafCondition `json:"allOf"`
}

type AlertRuleAnyOfOrLeafCondition 

type AlertRuleAnyOfOrLeafCondition struct {
	AnyOf       *[]AlertRuleLeafCondition `json:"anyOf,omitempty"`
	ContainsAny *[]string                 `json:"containsAny,omitempty"`
	Equals      *string                   `json:"equals,omitempty"`
	Field       *string                   `json:"field,omitempty"`
}

type AlertRuleLeafCondition 

type AlertRuleLeafCondition struct {
	ContainsAny *[]string `json:"containsAny,omitempty"`
	Equals      *string   `json:"equals,omitempty"`
	Field       *string   `json:"field,omitempty"`
}

type AlertRulePatchObject 

type AlertRulePatchObject struct {
	Properties *AlertRulePatchProperties `json:"properties,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
}

type AlertRulePatchProperties 

type AlertRulePatchProperties struct {
	Enabled *bool `json:"enabled,omitempty"`
}

type AlertRuleProperties 

type AlertRuleProperties struct {
	Actions     ActionList              `json:"actions"`
	Condition   AlertRuleAllOfCondition `json:"condition"`
	Description *string                 `json:"description,omitempty"`
	Enabled     *bool                   `json:"enabled,omitempty"`
	Scopes      []string                `json:"scopes"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.