actiongroupsapis

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

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

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

Client Initialization

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

Example Usage: ActionGroupsAPIsClient.ActionGroupsCreateOrUpdate

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

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", "actionGroupName")

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", "actionGroupName")

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", "actionGroupName")

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.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", "actionGroupName")

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

Types

type ActionGroup 

type ActionGroup struct {
	AutomationRunbookReceivers *[]AutomationRunbookReceiver `json:"automationRunbookReceivers,omitempty"`
	AzureAppPushReceivers      *[]AzureAppPushReceiver      `json:"azureAppPushReceivers,omitempty"`
	AzureFunctionReceivers     *[]AzureFunctionReceiver     `json:"azureFunctionReceivers,omitempty"`
	EmailReceivers             *[]EmailReceiver             `json:"emailReceivers,omitempty"`
	Enabled                    bool                         `json:"enabled"`
	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 

func (p ActionGroupResourceOperationPredicate) Matches(input ActionGroupResource) bool

type ActionGroupsAPIsClient 

type ActionGroupsAPIsClient struct {
	Client *resourcemanager.Client
}

func NewActionGroupsAPIsClientWithBaseURI 

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

func (ActionGroupsAPIsClient) ActionGroupsCreateOrUpdate 

func (c ActionGroupsAPIsClient) ActionGroupsCreateOrUpdate(ctx context.Context, id ActionGroupId, input ActionGroupResource) (result ActionGroupsCreateOrUpdateOperationResponse, err error)

ActionGroupsCreateOrUpdate ...

func (ActionGroupsAPIsClient) ActionGroupsDelete 

func (c ActionGroupsAPIsClient) ActionGroupsDelete(ctx context.Context, id ActionGroupId) (result ActionGroupsDeleteOperationResponse, err error)

ActionGroupsDelete ...

func (ActionGroupsAPIsClient) ActionGroupsEnableReceiver 

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

ActionGroupsEnableReceiver ...

func (ActionGroupsAPIsClient) ActionGroupsGet 

func (c ActionGroupsAPIsClient) ActionGroupsGet(ctx context.Context, id ActionGroupId) (result ActionGroupsGetOperationResponse, err error)

ActionGroupsGet ...

func (ActionGroupsAPIsClient) ActionGroupsListByResourceGroup 

func (c ActionGroupsAPIsClient) ActionGroupsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ActionGroupsListByResourceGroupOperationResponse, err error)

ActionGroupsListByResourceGroup ...

func (ActionGroupsAPIsClient) ActionGroupsListByResourceGroupComplete added in v0.20240226.1173038 

func (c ActionGroupsAPIsClient) ActionGroupsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ActionGroupsListByResourceGroupCompleteResult, error)

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 

func (c ActionGroupsAPIsClient) ActionGroupsListBySubscriptionId(ctx context.Context, id commonids.SubscriptionId) (result ActionGroupsListBySubscriptionIdOperationResponse, err error)

ActionGroupsListBySubscriptionId ...

func (ActionGroupsAPIsClient) ActionGroupsListBySubscriptionIdComplete added in v0.20240226.1173038 

func (c ActionGroupsAPIsClient) ActionGroupsListBySubscriptionIdComplete(ctx context.Context, id commonids.SubscriptionId) (ActionGroupsListBySubscriptionIdCompleteResult, error)

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 

func (c ActionGroupsAPIsClient) ActionGroupsUpdate(ctx context.Context, id ActionGroupId, input ActionGroupPatchBody) (result ActionGroupsUpdateOperationResponse, err error)

ActionGroupsUpdate ...

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 ActionGroupsListByResourceGroupCompleteResult added in v0.20240226.1173038 

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

type ActionGroupsListByResourceGroupCustomPager added in v0.20240628.1153531 

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

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 ActionGroupsListBySubscriptionIdCustomPager added in v0.20240628.1153531 

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

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 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"`
	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"`
}

type EmailReceiver 

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

type EnableRequest 

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

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"`
}

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 VoiceReceiver 

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

type WebhookReceiver 

type WebhookReceiver struct {
	Name       string `json:"name"`
	ServiceUri string `json:"serviceUri"`
}

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.