actiongroupsapis

package
v0.20240611.1085123 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2023-01-01/actiongroupsapis Documentation

The actiongroupsapis SDK allows for interaction with the Azure Resource Manager Service insights (API Version 2023-01-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/2023-01-01/actiongroupsapis"

Client Initialization

client := actiongroupsapis.NewActionGroupsAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ActionGroupsAPIsClient.ActionGroupsCreateNotificationsAtActionGroupResourceLevel

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

payload := actiongroupsapis.NotificationRequestBody{
	// ...
}


if err := client.ActionGroupsCreateNotificationsAtActionGroupResourceLevelThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ActionGroupsAPIsClient.ActionGroupsCreateOrUpdate

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

payload := actiongroupsapis.ActionGroupResource{
	// ...
}


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

Example Usage: ActionGroupsAPIsClient.ActionGroupsDelete

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

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

Example Usage: ActionGroupsAPIsClient.ActionGroupsEnableReceiver

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

payload := actiongroupsapis.EnableRequest{
	// ...
}


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

Example Usage: ActionGroupsAPIsClient.ActionGroupsGet

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

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

Example Usage: ActionGroupsAPIsClient.ActionGroupsGetTestNotificationsAtActionGroupResourceLevel

ctx := context.TODO()
id := actiongroupsapis.NewNotificationStatusID("12345678-1234-9876-4563-123456789012", "example-resource-group", "actionGroupValue", "notificationIdValue")

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

Example Usage: ActionGroupsAPIsClient.ActionGroupsListByResourceGroup

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

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

Example Usage: ActionGroupsAPIsClient.ActionGroupsListBySubscriptionId

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

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

Example Usage: ActionGroupsAPIsClient.ActionGroupsUpdate

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

payload := actiongroupsapis.ActionGroupPatchBody{
	// ...
}


read, err := client.ActionGroupsUpdate(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 PossibleValuesForReceiverStatus

func PossibleValuesForReceiverStatus() []string

func ValidateActionGroupID

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

ValidateActionGroupID checks that 'input' can be parsed as a Action Group ID

func ValidateNotificationStatusID

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

ValidateNotificationStatusID checks that 'input' can be parsed as a Notification Status ID

Types

type ActionDetail

type ActionDetail struct {
	Detail        *string `json:"Detail,omitempty"`
	MechanismType *string `json:"MechanismType,omitempty"`
	Name          *string `json:"Name,omitempty"`
	SendTime      *string `json:"SendTime,omitempty"`
	Status        *string `json:"Status,omitempty"`
	SubState      *string `json:"SubState,omitempty"`
}

type ActionGroup

type ActionGroup struct {
	ArmRoleReceivers           *[]ArmRoleReceiver           `json:"armRoleReceivers,omitempty"`
	AutomationRunbookReceivers *[]AutomationRunbookReceiver `json:"automationRunbookReceivers,omitempty"`
	AzureAppPushReceivers      *[]AzureAppPushReceiver      `json:"azureAppPushReceivers,omitempty"`
	AzureFunctionReceivers     *[]AzureFunctionReceiver     `json:"azureFunctionReceivers,omitempty"`
	EmailReceivers             *[]EmailReceiver             `json:"emailReceivers,omitempty"`
	Enabled                    bool                         `json:"enabled"`
	EventHubReceivers          *[]EventHubReceiver          `json:"eventHubReceivers,omitempty"`
	GroupShortName             string                       `json:"groupShortName"`
	ItsmReceivers              *[]ItsmReceiver              `json:"itsmReceivers,omitempty"`
	LogicAppReceivers          *[]LogicAppReceiver          `json:"logicAppReceivers,omitempty"`
	SmsReceivers               *[]SmsReceiver               `json:"smsReceivers,omitempty"`
	VoiceReceivers             *[]VoiceReceiver             `json:"voiceReceivers,omitempty"`
	WebhookReceivers           *[]WebhookReceiver           `json:"webhookReceivers,omitempty"`
}

type ActionGroupId

type ActionGroupId struct {
	SubscriptionId    string
	ResourceGroupName string
	ActionGroupName   string
}

ActionGroupId is a struct representing the Resource ID for a Action Group

func NewActionGroupID

func NewActionGroupID(subscriptionId string, resourceGroupName string, actionGroupName string) ActionGroupId

NewActionGroupID returns a new ActionGroupId struct

func ParseActionGroupID

func ParseActionGroupID(input string) (*ActionGroupId, error)

ParseActionGroupID parses 'input' into a ActionGroupId

func ParseActionGroupIDInsensitively

func ParseActionGroupIDInsensitively(input string) (*ActionGroupId, error)

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

func (*ActionGroupId) FromParseResult

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

func (ActionGroupId) ID

func (id ActionGroupId) ID() string

ID returns the formatted Action Group ID

func (ActionGroupId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Action Group ID

func (ActionGroupId) String

func (id ActionGroupId) String() string

String returns a human-readable description of this Action Group ID

type ActionGroupPatch

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

type ActionGroupPatchBody

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

type ActionGroupResource

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

type ActionGroupResourceOperationPredicate added in v0.20240226.1173038

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

func (ActionGroupResourceOperationPredicate) Matches added in v0.20240226.1173038

type ActionGroupsAPIsClient

type ActionGroupsAPIsClient struct {
	Client *resourcemanager.Client
}

func NewActionGroupsAPIsClientWithBaseURI

func NewActionGroupsAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*ActionGroupsAPIsClient, error)

func (ActionGroupsAPIsClient) ActionGroupsCreateNotificationsAtActionGroupResourceLevel

func (c ActionGroupsAPIsClient) ActionGroupsCreateNotificationsAtActionGroupResourceLevel(ctx context.Context, id ActionGroupId, input NotificationRequestBody) (result ActionGroupsCreateNotificationsAtActionGroupResourceLevelOperationResponse, err error)

ActionGroupsCreateNotificationsAtActionGroupResourceLevel ...

func (ActionGroupsAPIsClient) ActionGroupsCreateNotificationsAtActionGroupResourceLevelThenPoll

func (c ActionGroupsAPIsClient) ActionGroupsCreateNotificationsAtActionGroupResourceLevelThenPoll(ctx context.Context, id ActionGroupId, input NotificationRequestBody) error

ActionGroupsCreateNotificationsAtActionGroupResourceLevelThenPoll performs ActionGroupsCreateNotificationsAtActionGroupResourceLevel then polls until it's completed

func (ActionGroupsAPIsClient) ActionGroupsCreateOrUpdate

ActionGroupsCreateOrUpdate ...

func (ActionGroupsAPIsClient) ActionGroupsDelete

ActionGroupsDelete ...

func (ActionGroupsAPIsClient) ActionGroupsEnableReceiver

func (c ActionGroupsAPIsClient) ActionGroupsEnableReceiver(ctx context.Context, id ActionGroupId, input EnableRequest) (result ActionGroupsEnableReceiverOperationResponse, err error)

ActionGroupsEnableReceiver ...

func (ActionGroupsAPIsClient) ActionGroupsGet

ActionGroupsGet ...

func (ActionGroupsAPIsClient) ActionGroupsGetTestNotificationsAtActionGroupResourceLevel

func (c ActionGroupsAPIsClient) ActionGroupsGetTestNotificationsAtActionGroupResourceLevel(ctx context.Context, id NotificationStatusId) (result ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOperationResponse, err error)

ActionGroupsGetTestNotificationsAtActionGroupResourceLevel ...

func (ActionGroupsAPIsClient) ActionGroupsListByResourceGroup

ActionGroupsListByResourceGroup ...

func (ActionGroupsAPIsClient) ActionGroupsListByResourceGroupComplete added in v0.20240226.1173038

ActionGroupsListByResourceGroupComplete retrieves all the results into a single object

func (ActionGroupsAPIsClient) ActionGroupsListByResourceGroupCompleteMatchingPredicate added in v0.20240226.1173038

func (c ActionGroupsAPIsClient) ActionGroupsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ActionGroupResourceOperationPredicate) (result ActionGroupsListByResourceGroupCompleteResult, err error)

ActionGroupsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ActionGroupsAPIsClient) ActionGroupsListBySubscriptionId

ActionGroupsListBySubscriptionId ...

func (ActionGroupsAPIsClient) ActionGroupsListBySubscriptionIdComplete added in v0.20240226.1173038

ActionGroupsListBySubscriptionIdComplete retrieves all the results into a single object

func (ActionGroupsAPIsClient) ActionGroupsListBySubscriptionIdCompleteMatchingPredicate added in v0.20240226.1173038

func (c ActionGroupsAPIsClient) ActionGroupsListBySubscriptionIdCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ActionGroupResourceOperationPredicate) (result ActionGroupsListBySubscriptionIdCompleteResult, err error)

ActionGroupsListBySubscriptionIdCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ActionGroupsAPIsClient) ActionGroupsUpdate

ActionGroupsUpdate ...

type ActionGroupsCreateNotificationsAtActionGroupResourceLevelOperationResponse

type ActionGroupsCreateNotificationsAtActionGroupResourceLevelOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TestNotificationDetailsResponse
}

type ActionGroupsCreateOrUpdateOperationResponse

type ActionGroupsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActionGroupResource
}

type ActionGroupsDeleteOperationResponse

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

type ActionGroupsEnableReceiverOperationResponse

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

type ActionGroupsGetOperationResponse

type ActionGroupsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActionGroupResource
}

type ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOperationResponse

type ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TestNotificationDetailsResponse
}

type ActionGroupsListByResourceGroupCompleteResult added in v0.20240226.1173038

type ActionGroupsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ActionGroupResource
}

type ActionGroupsListByResourceGroupOperationResponse

type ActionGroupsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ActionGroupResource
}

type ActionGroupsListBySubscriptionIdCompleteResult added in v0.20240226.1173038

type ActionGroupsListBySubscriptionIdCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ActionGroupResource
}

type ActionGroupsListBySubscriptionIdOperationResponse

type ActionGroupsListBySubscriptionIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ActionGroupResource
}

type ActionGroupsUpdateOperationResponse

type ActionGroupsUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActionGroupResource
}

type ArmRoleReceiver

type ArmRoleReceiver struct {
	Name                 string `json:"name"`
	RoleId               string `json:"roleId"`
	UseCommonAlertSchema *bool  `json:"useCommonAlertSchema,omitempty"`
}

type AutomationRunbookReceiver

type AutomationRunbookReceiver struct {
	AutomationAccountId  string  `json:"automationAccountId"`
	IsGlobalRunbook      bool    `json:"isGlobalRunbook"`
	Name                 *string `json:"name,omitempty"`
	RunbookName          string  `json:"runbookName"`
	ServiceUri           *string `json:"serviceUri,omitempty"`
	UseCommonAlertSchema *bool   `json:"useCommonAlertSchema,omitempty"`
	WebhookResourceId    string  `json:"webhookResourceId"`
}

type AzureAppPushReceiver

type AzureAppPushReceiver struct {
	EmailAddress string `json:"emailAddress"`
	Name         string `json:"name"`
}

type AzureFunctionReceiver

type AzureFunctionReceiver struct {
	FunctionAppResourceId string `json:"functionAppResourceId"`
	FunctionName          string `json:"functionName"`
	HTTPTriggerUrl        string `json:"httpTriggerUrl"`
	Name                  string `json:"name"`
	UseCommonAlertSchema  *bool  `json:"useCommonAlertSchema,omitempty"`
}

type Context

type Context struct {
	ContextType        *string `json:"contextType,omitempty"`
	NotificationSource *string `json:"notificationSource,omitempty"`
}

type EmailReceiver

type EmailReceiver struct {
	EmailAddress         string          `json:"emailAddress"`
	Name                 string          `json:"name"`
	Status               *ReceiverStatus `json:"status,omitempty"`
	UseCommonAlertSchema *bool           `json:"useCommonAlertSchema,omitempty"`
}

type EnableRequest

type EnableRequest struct {
	ReceiverName string `json:"receiverName"`
}

type EventHubReceiver

type EventHubReceiver struct {
	EventHubName         string  `json:"eventHubName"`
	EventHubNameSpace    string  `json:"eventHubNameSpace"`
	Name                 string  `json:"name"`
	SubscriptionId       string  `json:"subscriptionId"`
	TenantId             *string `json:"tenantId,omitempty"`
	UseCommonAlertSchema *bool   `json:"useCommonAlertSchema,omitempty"`
}

type ItsmReceiver

type ItsmReceiver struct {
	ConnectionId        string `json:"connectionId"`
	Name                string `json:"name"`
	Region              string `json:"region"`
	TicketConfiguration string `json:"ticketConfiguration"`
	WorkspaceId         string `json:"workspaceId"`
}

type LogicAppReceiver

type LogicAppReceiver struct {
	CallbackUrl          string `json:"callbackUrl"`
	Name                 string `json:"name"`
	ResourceId           string `json:"resourceId"`
	UseCommonAlertSchema *bool  `json:"useCommonAlertSchema,omitempty"`
}

type NotificationRequestBody

type NotificationRequestBody struct {
	AlertType                  string                       `json:"alertType"`
	ArmRoleReceivers           *[]ArmRoleReceiver           `json:"armRoleReceivers,omitempty"`
	AutomationRunbookReceivers *[]AutomationRunbookReceiver `json:"automationRunbookReceivers,omitempty"`
	AzureAppPushReceivers      *[]AzureAppPushReceiver      `json:"azureAppPushReceivers,omitempty"`
	AzureFunctionReceivers     *[]AzureFunctionReceiver     `json:"azureFunctionReceivers,omitempty"`
	EmailReceivers             *[]EmailReceiver             `json:"emailReceivers,omitempty"`
	EventHubReceivers          *[]EventHubReceiver          `json:"eventHubReceivers,omitempty"`
	ItsmReceivers              *[]ItsmReceiver              `json:"itsmReceivers,omitempty"`
	LogicAppReceivers          *[]LogicAppReceiver          `json:"logicAppReceivers,omitempty"`
	SmsReceivers               *[]SmsReceiver               `json:"smsReceivers,omitempty"`
	VoiceReceivers             *[]VoiceReceiver             `json:"voiceReceivers,omitempty"`
	WebhookReceivers           *[]WebhookReceiver           `json:"webhookReceivers,omitempty"`
}

type NotificationStatusId

type NotificationStatusId struct {
	SubscriptionId    string
	ResourceGroupName string
	ActionGroupName   string
	NotificationId    string
}

NotificationStatusId is a struct representing the Resource ID for a Notification Status

func NewNotificationStatusID

func NewNotificationStatusID(subscriptionId string, resourceGroupName string, actionGroupName string, notificationId string) NotificationStatusId

NewNotificationStatusID returns a new NotificationStatusId struct

func ParseNotificationStatusID

func ParseNotificationStatusID(input string) (*NotificationStatusId, error)

ParseNotificationStatusID parses 'input' into a NotificationStatusId

func ParseNotificationStatusIDInsensitively

func ParseNotificationStatusIDInsensitively(input string) (*NotificationStatusId, error)

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

func (*NotificationStatusId) FromParseResult

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

func (NotificationStatusId) ID

func (id NotificationStatusId) ID() string

ID returns the formatted Notification Status ID

func (NotificationStatusId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Notification Status ID

func (NotificationStatusId) String

func (id NotificationStatusId) String() string

String returns a human-readable description of this Notification Status ID

type ReceiverStatus

type ReceiverStatus string
const (
	ReceiverStatusDisabled     ReceiverStatus = "Disabled"
	ReceiverStatusEnabled      ReceiverStatus = "Enabled"
	ReceiverStatusNotSpecified ReceiverStatus = "NotSpecified"
)

func (*ReceiverStatus) UnmarshalJSON added in v0.20240229.1102109

func (s *ReceiverStatus) UnmarshalJSON(bytes []byte) error

type SmsReceiver

type SmsReceiver struct {
	CountryCode string          `json:"countryCode"`
	Name        string          `json:"name"`
	PhoneNumber string          `json:"phoneNumber"`
	Status      *ReceiverStatus `json:"status,omitempty"`
}

type TestNotificationDetailsResponse

type TestNotificationDetailsResponse struct {
	ActionDetails *[]ActionDetail `json:"actionDetails,omitempty"`
	CompletedTime *string         `json:"completedTime,omitempty"`
	Context       *Context        `json:"context,omitempty"`
	CreatedTime   *string         `json:"createdTime,omitempty"`
	State         string          `json:"state"`
}

type VoiceReceiver

type VoiceReceiver struct {
	CountryCode string `json:"countryCode"`
	Name        string `json:"name"`
	PhoneNumber string `json:"phoneNumber"`
}

type WebhookReceiver

type WebhookReceiver struct {
	IdentifierUri        *string `json:"identifierUri,omitempty"`
	Name                 string  `json:"name"`
	ObjectId             *string `json:"objectId,omitempty"`
	ServiceUri           string  `json:"serviceUri"`
	TenantId             *string `json:"tenantId,omitempty"`
	UseAadAuth           *bool   `json:"useAadAuth,omitempty"`
	UseCommonAlertSchema *bool   `json:"useCommonAlertSchema,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL