insights

package
v59.3.3+incompatible Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2021 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package insights implements the Azure ARM Insights service API version 2021-09-01.

Monitor Management Client

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

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

func Version

func Version() string

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

Types

type ActionDetail

type ActionDetail struct {
	// MechanismType - The mechanism type
	MechanismType *string `json:"MechanismType,omitempty"`
	// Name - The name of the action
	Name *string `json:"Name,omitempty"`
	// Status - The status of the action
	Status *string `json:"Status,omitempty"`
	// SubState - The substatus of the action
	SubState *string `json:"SubState,omitempty"`
	// SendTime - The send time
	SendTime *string `json:"SendTime,omitempty"`
	// Detail - The detail of the friendly error message
	Detail *string `json:"Detail,omitempty"`
}

ActionDetail the action detail

type ActionGroup

type ActionGroup struct {
	// GroupShortName - The short name of the action group. This will be used in SMS messages.
	GroupShortName *string `json:"groupShortName,omitempty"`
	// Enabled - Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
	Enabled *bool `json:"enabled,omitempty"`
	// EmailReceivers - The list of email receivers that are part of this action group.
	EmailReceivers *[]EmailReceiver `json:"emailReceivers,omitempty"`
	// SmsReceivers - The list of SMS receivers that are part of this action group.
	SmsReceivers *[]SmsReceiver `json:"smsReceivers,omitempty"`
	// WebhookReceivers - The list of webhook receivers that are part of this action group.
	WebhookReceivers *[]WebhookReceiver `json:"webhookReceivers,omitempty"`
	// ItsmReceivers - The list of ITSM receivers that are part of this action group.
	ItsmReceivers *[]ItsmReceiver `json:"itsmReceivers,omitempty"`
	// AzureAppPushReceivers - The list of AzureAppPush receivers that are part of this action group.
	AzureAppPushReceivers *[]AzureAppPushReceiver `json:"azureAppPushReceivers,omitempty"`
	// AutomationRunbookReceivers - The list of AutomationRunbook receivers that are part of this action group.
	AutomationRunbookReceivers *[]AutomationRunbookReceiver `json:"automationRunbookReceivers,omitempty"`
	// VoiceReceivers - The list of voice receivers that are part of this action group.
	VoiceReceivers *[]VoiceReceiver `json:"voiceReceivers,omitempty"`
	// LogicAppReceivers - The list of logic app receivers that are part of this action group.
	LogicAppReceivers *[]LogicAppReceiver `json:"logicAppReceivers,omitempty"`
	// AzureFunctionReceivers - The list of azure function receivers that are part of this action group.
	AzureFunctionReceivers *[]AzureFunctionReceiver `json:"azureFunctionReceivers,omitempty"`
	// ArmRoleReceivers - The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
	ArmRoleReceivers *[]ArmRoleReceiver `json:"armRoleReceivers,omitempty"`
	// EventHubReceivers - The list of event hub receivers that are part of this action group.
	EventHubReceivers *[]EventHubReceiver `json:"eventHubReceivers,omitempty"`
}

ActionGroup an Azure action group.

type ActionGroupList

type ActionGroupList struct {
	autorest.Response `json:"-"`
	// Value - The list of action groups.
	Value *[]ActionGroupResource `json:"value,omitempty"`
	// NextLink - Provides the link to retrieve the next set of elements.
	NextLink *string `json:"nextLink,omitempty"`
}

ActionGroupList a list of action groups.

type ActionGroupPatch

type ActionGroupPatch struct {
	// Enabled - Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated.
	Enabled *bool `json:"enabled,omitempty"`
}

ActionGroupPatch an Azure action group for patch operations.

type ActionGroupPatchBody

type ActionGroupPatchBody struct {
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// ActionGroupPatch - The action group settings for an update operation.
	*ActionGroupPatch `json:"properties,omitempty"`
}

ActionGroupPatchBody an action group object for the body of patch operations.

func (ActionGroupPatchBody) MarshalJSON

func (agpb ActionGroupPatchBody) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ActionGroupPatchBody.

func (*ActionGroupPatchBody) UnmarshalJSON

func (agpb *ActionGroupPatchBody) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ActionGroupPatchBody struct.

type ActionGroupResource

type ActionGroupResource struct {
	autorest.Response `json:"-"`
	// ActionGroup - The action groups properties of the resource.
	*ActionGroup `json:"properties,omitempty"`
	// ID - READ-ONLY; Azure resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Azure resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Azure resource type
	Type *string `json:"type,omitempty"`
	// Kind - READ-ONLY; Azure resource kind
	Kind *string `json:"kind,omitempty"`
	// Identity - READ-ONLY; Azure resource identity
	Identity *string `json:"identity,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

ActionGroupResource an action group resource.

func (ActionGroupResource) MarshalJSON

func (agr ActionGroupResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ActionGroupResource.

func (*ActionGroupResource) UnmarshalJSON

func (agr *ActionGroupResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ActionGroupResource struct.

type ActionGroupsClient

type ActionGroupsClient struct {
	BaseClient
}

ActionGroupsClient is the monitor Management Client

func NewActionGroupsClient

func NewActionGroupsClient(subscriptionID string) ActionGroupsClient

NewActionGroupsClient creates an instance of the ActionGroupsClient client.

func NewActionGroupsClientWithBaseURI

func NewActionGroupsClientWithBaseURI(baseURI string, subscriptionID string) ActionGroupsClient

NewActionGroupsClientWithBaseURI creates an instance of the ActionGroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ActionGroupsClient) CreateOrUpdate

func (client ActionGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, actionGroupName string, actionGroup ActionGroupResource) (result ActionGroupResource, err error)

CreateOrUpdate create a new action group or update an existing one. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. actionGroupName - the name of the action group. actionGroup - the action group to create or use for the update.

func (ActionGroupsClient) CreateOrUpdatePreparer

func (client ActionGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, actionGroupName string, actionGroup ActionGroupResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ActionGroupsClient) CreateOrUpdateResponder

func (client ActionGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result ActionGroupResource, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ActionGroupsClient) CreateOrUpdateSender

func (client ActionGroupsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (ActionGroupsClient) Delete

func (client ActionGroupsClient) Delete(ctx context.Context, resourceGroupName string, actionGroupName string) (result autorest.Response, err error)

Delete delete an action group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. actionGroupName - the name of the action group.

func (ActionGroupsClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (ActionGroupsClient) DeleteResponder

func (client ActionGroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ActionGroupsClient) DeleteSender

func (client ActionGroupsClient) 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 (ActionGroupsClient) EnableReceiver

func (client ActionGroupsClient) EnableReceiver(ctx context.Context, resourceGroupName string, actionGroupName string, enableRequest EnableRequest) (result autorest.Response, err error)

EnableReceiver enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. actionGroupName - the name of the action group. enableRequest - the receiver to re-enable.

func (ActionGroupsClient) EnableReceiverPreparer

func (client ActionGroupsClient) EnableReceiverPreparer(ctx context.Context, resourceGroupName string, actionGroupName string, enableRequest EnableRequest) (*http.Request, error)

EnableReceiverPreparer prepares the EnableReceiver request.

func (ActionGroupsClient) EnableReceiverResponder

func (client ActionGroupsClient) EnableReceiverResponder(resp *http.Response) (result autorest.Response, err error)

EnableReceiverResponder handles the response to the EnableReceiver request. The method always closes the http.Response Body.

func (ActionGroupsClient) EnableReceiverSender

func (client ActionGroupsClient) EnableReceiverSender(req *http.Request) (*http.Response, error)

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

func (ActionGroupsClient) Get

func (client ActionGroupsClient) Get(ctx context.Context, resourceGroupName string, actionGroupName string) (result ActionGroupResource, err error)

Get get an action group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. actionGroupName - the name of the action group.

func (ActionGroupsClient) GetPreparer

func (client ActionGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, actionGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ActionGroupsClient) GetResponder

func (client ActionGroupsClient) GetResponder(resp *http.Response) (result ActionGroupResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ActionGroupsClient) GetSender

func (client ActionGroupsClient) GetSender(req *http.Request) (*http.Response, error)

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

func (ActionGroupsClient) GetTestNotifications

func (client ActionGroupsClient) GetTestNotifications(ctx context.Context, notificationID string) (result TestNotificationDetailsResponse, err error)

GetTestNotifications get the test notifications by the notification id Parameters: notificationID - the notification id

func (ActionGroupsClient) GetTestNotificationsPreparer

func (client ActionGroupsClient) GetTestNotificationsPreparer(ctx context.Context, notificationID string) (*http.Request, error)

GetTestNotificationsPreparer prepares the GetTestNotifications request.

func (ActionGroupsClient) GetTestNotificationsResponder

func (client ActionGroupsClient) GetTestNotificationsResponder(resp *http.Response) (result TestNotificationDetailsResponse, err error)

GetTestNotificationsResponder handles the response to the GetTestNotifications request. The method always closes the http.Response Body.

func (ActionGroupsClient) GetTestNotificationsSender

func (client ActionGroupsClient) GetTestNotificationsSender(req *http.Request) (*http.Response, error)

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

func (ActionGroupsClient) ListByResourceGroup

func (client ActionGroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ActionGroupList, err error)

ListByResourceGroup get a list of all action groups in a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (ActionGroupsClient) ListByResourceGroupPreparer

func (client ActionGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ActionGroupsClient) ListByResourceGroupResponder

func (client ActionGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result ActionGroupList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ActionGroupsClient) ListByResourceGroupSender

func (client ActionGroupsClient) 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 (ActionGroupsClient) ListBySubscriptionID

func (client ActionGroupsClient) ListBySubscriptionID(ctx context.Context) (result ActionGroupList, err error)

ListBySubscriptionID get a list of all action groups in a subscription.

func (ActionGroupsClient) ListBySubscriptionIDPreparer

func (client ActionGroupsClient) ListBySubscriptionIDPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.

func (ActionGroupsClient) ListBySubscriptionIDResponder

func (client ActionGroupsClient) ListBySubscriptionIDResponder(resp *http.Response) (result ActionGroupList, err error)

ListBySubscriptionIDResponder handles the response to the ListBySubscriptionID request. The method always closes the http.Response Body.

func (ActionGroupsClient) ListBySubscriptionIDSender

func (client ActionGroupsClient) ListBySubscriptionIDSender(req *http.Request) (*http.Response, error)

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

func (ActionGroupsClient) PostTestNotifications

func (client ActionGroupsClient) PostTestNotifications(ctx context.Context, notificationRequest NotificationRequestBody) (result ActionGroupsPostTestNotificationsFuture, err error)

PostTestNotifications send test notifications to a set of provided receivers Parameters: notificationRequest - the notification request body which includes the contact details

func (ActionGroupsClient) PostTestNotificationsPreparer

func (client ActionGroupsClient) PostTestNotificationsPreparer(ctx context.Context, notificationRequest NotificationRequestBody) (*http.Request, error)

PostTestNotificationsPreparer prepares the PostTestNotifications request.

func (ActionGroupsClient) PostTestNotificationsResponder

func (client ActionGroupsClient) PostTestNotificationsResponder(resp *http.Response) (result TestNotificationResponse, err error)

PostTestNotificationsResponder handles the response to the PostTestNotifications request. The method always closes the http.Response Body.

func (ActionGroupsClient) PostTestNotificationsSender

func (client ActionGroupsClient) PostTestNotificationsSender(req *http.Request) (future ActionGroupsPostTestNotificationsFuture, err error)

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

func (ActionGroupsClient) Update

func (client ActionGroupsClient) Update(ctx context.Context, resourceGroupName string, actionGroupName string, actionGroupPatch ActionGroupPatchBody) (result ActionGroupResource, err error)

Update updates an existing action group's tags. To update other fields use the CreateOrUpdate method. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. actionGroupName - the name of the action group. actionGroupPatch - parameters supplied to the operation.

func (ActionGroupsClient) UpdatePreparer

func (client ActionGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, actionGroupName string, actionGroupPatch ActionGroupPatchBody) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ActionGroupsClient) UpdateResponder

func (client ActionGroupsClient) UpdateResponder(resp *http.Response) (result ActionGroupResource, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ActionGroupsClient) UpdateSender

func (client ActionGroupsClient) 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 ActionGroupsPostTestNotificationsFuture

type ActionGroupsPostTestNotificationsFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ActionGroupsClient) (TestNotificationResponse, error)
}

ActionGroupsPostTestNotificationsFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ActionGroupsPostTestNotificationsFuture) UnmarshalJSON

func (future *ActionGroupsPostTestNotificationsFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ArmRoleReceiver

type ArmRoleReceiver struct {
	// Name - The name of the arm role receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// RoleID - The arm role id.
	RoleID *string `json:"roleId,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
}

ArmRoleReceiver an arm role receiver.

type AutomationRunbookReceiver

type AutomationRunbookReceiver struct {
	// AutomationAccountID - The Azure automation account Id which holds this runbook and authenticate to Azure resource.
	AutomationAccountID *string `json:"automationAccountId,omitempty"`
	// RunbookName - The name for this runbook.
	RunbookName *string `json:"runbookName,omitempty"`
	// WebhookResourceID - The resource id for webhook linked to this runbook.
	WebhookResourceID *string `json:"webhookResourceId,omitempty"`
	// IsGlobalRunbook - Indicates whether this instance is global runbook.
	IsGlobalRunbook *bool `json:"isGlobalRunbook,omitempty"`
	// Name - Indicates name of the webhook.
	Name *string `json:"name,omitempty"`
	// ServiceURI - The URI where webhooks should be sent.
	ServiceURI *string `json:"serviceUri,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
}

AutomationRunbookReceiver the Azure Automation Runbook notification receiver.

type AzureAppPushReceiver

type AzureAppPushReceiver struct {
	// Name - The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// EmailAddress - The email address registered for the Azure mobile app.
	EmailAddress *string `json:"emailAddress,omitempty"`
}

AzureAppPushReceiver the Azure mobile App push notification receiver.

type AzureFunctionReceiver

type AzureFunctionReceiver struct {
	// Name - The name of the azure function receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// FunctionAppResourceID - The azure resource id of the function app.
	FunctionAppResourceID *string `json:"functionAppResourceId,omitempty"`
	// FunctionName - The function name in the function app.
	FunctionName *string `json:"functionName,omitempty"`
	// HTTPTriggerURL - The http trigger url where http request sent to.
	HTTPTriggerURL *string `json:"httpTriggerUrl,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
}

AzureFunctionReceiver an azure function receiver.

type AzureResource

type AzureResource struct {
	// ID - READ-ONLY; Azure resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Azure resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Azure resource type
	Type *string `json:"type,omitempty"`
	// Kind - READ-ONLY; Azure resource kind
	Kind *string `json:"kind,omitempty"`
	// Identity - READ-ONLY; Azure resource identity
	Identity *string `json:"identity,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

AzureResource an azure resource object

func (AzureResource) MarshalJSON

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

MarshalJSON is the custom marshaler for AzureResource.

type BaseClient

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

BaseClient is the base client for Insights.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Context

type Context struct {
	// NotificationSource - The source of the notification request
	NotificationSource *string `json:"NotificationSource,omitempty"`
	// ContextType - The context id type
	ContextType *string `json:"ContextType,omitempty"`
}

Context the context info

type EmailReceiver

type EmailReceiver struct {
	// Name - The name of the email receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// EmailAddress - The email address of this receiver.
	EmailAddress *string `json:"emailAddress,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
	// Status - READ-ONLY; The receiver status of the e-mail. Possible values include: 'ReceiverStatusNotSpecified', 'ReceiverStatusEnabled', 'ReceiverStatusDisabled'
	Status ReceiverStatus `json:"status,omitempty"`
}

EmailReceiver an email receiver.

func (EmailReceiver) MarshalJSON

func (er EmailReceiver) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EmailReceiver.

type EnableRequest

type EnableRequest struct {
	// ReceiverName - The name of the receiver to resubscribe.
	ReceiverName *string `json:"receiverName,omitempty"`
}

EnableRequest describes a receiver that should be resubscribed.

type ErrorResponse

type ErrorResponse struct {
	// Code - Error code
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse describes the format of Error response.

type EventHubReceiver

type EventHubReceiver struct {
	// Name - The name of the Event hub receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// EventHubNameSpace - The Event Hub namespace
	EventHubNameSpace *string `json:"eventHubNameSpace,omitempty"`
	// EventHubName - The name of the specific Event Hub queue
	EventHubName *string `json:"eventHubName,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
	// TenantID - The tenant Id for the subscription containing this event hub
	TenantID *string `json:"tenantId,omitempty"`
	// SubscriptionID - The Id for the subscription containing this event hub
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

EventHubReceiver an Event hub receiver.

type ItsmReceiver

type ItsmReceiver struct {
	// Name - The name of the Itsm receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// WorkspaceID - OMS LA instance identifier.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// ConnectionID - Unique identification of ITSM connection among multiple defined in above workspace.
	ConnectionID *string `json:"connectionId,omitempty"`
	// TicketConfiguration - JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
	TicketConfiguration *string `json:"ticketConfiguration,omitempty"`
	// Region - Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
	Region *string `json:"region,omitempty"`
}

ItsmReceiver an Itsm receiver.

type LogicAppReceiver

type LogicAppReceiver struct {
	// Name - The name of the logic app receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// ResourceID - The azure resource id of the logic app receiver.
	ResourceID *string `json:"resourceId,omitempty"`
	// CallbackURL - The callback url where http request sent to.
	CallbackURL *string `json:"callbackUrl,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
}

LogicAppReceiver a logic app receiver.

type NotificationRequestBody

type NotificationRequestBody struct {
	// AlertType - The name of the supported alert type.
	AlertType *string `json:"alertType,omitempty"`
	// EmailReceivers - The list of email receivers that are part of this action group.
	EmailReceivers *[]EmailReceiver `json:"emailReceivers,omitempty"`
	// SmsReceivers - The list of SMS receivers that are part of this action group.
	SmsReceivers *[]SmsReceiver `json:"smsReceivers,omitempty"`
	// WebhookReceivers - The list of webhook receivers that are part of this action group.
	WebhookReceivers *[]WebhookReceiver `json:"webhookReceivers,omitempty"`
	// ItsmReceivers - The list of ITSM receivers that are part of this action group.
	ItsmReceivers *[]ItsmReceiver `json:"itsmReceivers,omitempty"`
	// AzureAppPushReceivers - The list of AzureAppPush receivers that are part of this action group.
	AzureAppPushReceivers *[]AzureAppPushReceiver `json:"azureAppPushReceivers,omitempty"`
	// AutomationRunbookReceivers - The list of AutomationRunbook receivers that are part of this action group.
	AutomationRunbookReceivers *[]AutomationRunbookReceiver `json:"automationRunbookReceivers,omitempty"`
	// VoiceReceivers - The list of voice receivers that are part of this action group.
	VoiceReceivers *[]VoiceReceiver `json:"voiceReceivers,omitempty"`
	// LogicAppReceivers - The list of logic app receivers that are part of this action group.
	LogicAppReceivers *[]LogicAppReceiver `json:"logicAppReceivers,omitempty"`
	// AzureFunctionReceivers - The list of azure function receivers that are part of this action group.
	AzureFunctionReceivers *[]AzureFunctionReceiver `json:"azureFunctionReceivers,omitempty"`
	// ArmRoleReceivers - The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
	ArmRoleReceivers *[]ArmRoleReceiver `json:"armRoleReceivers,omitempty"`
	// EventHubReceivers - The list of event hub receivers that are part of this action group.
	EventHubReceivers *[]EventHubReceiver `json:"eventHubReceivers,omitempty"`
}

NotificationRequestBody the request body which contain contact detail metadata

type ReceiverStatus

type ReceiverStatus string

ReceiverStatus enumerates the values for receiver status.

const (
	// ReceiverStatusDisabled ...
	ReceiverStatusDisabled ReceiverStatus = "Disabled"
	// ReceiverStatusEnabled ...
	ReceiverStatusEnabled ReceiverStatus = "Enabled"
	// ReceiverStatusNotSpecified ...
	ReceiverStatusNotSpecified ReceiverStatus = "NotSpecified"
)

func PossibleReceiverStatusValues

func PossibleReceiverStatusValues() []ReceiverStatus

PossibleReceiverStatusValues returns an array of possible values for the ReceiverStatus const type.

type SmsReceiver

type SmsReceiver struct {
	// Name - The name of the SMS receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// CountryCode - The country code of the SMS receiver.
	CountryCode *string `json:"countryCode,omitempty"`
	// PhoneNumber - The phone number of the SMS receiver.
	PhoneNumber *string `json:"phoneNumber,omitempty"`
	// Status - READ-ONLY; The status of the receiver. Possible values include: 'ReceiverStatusNotSpecified', 'ReceiverStatusEnabled', 'ReceiverStatusDisabled'
	Status ReceiverStatus `json:"status,omitempty"`
}

SmsReceiver an SMS receiver.

func (SmsReceiver) MarshalJSON

func (sr SmsReceiver) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SmsReceiver.

type TestNotificationDetailsResponse

type TestNotificationDetailsResponse struct {
	autorest.Response `json:"-"`
	Context           *Context `json:"Context,omitempty"`
	// State - The overall state
	State *string `json:"State,omitempty"`
	// CompletedTime - The completed time
	CompletedTime *string `json:"CompletedTime,omitempty"`
	// CreatedTime - The created time
	CreatedTime *string `json:"CreatedTime,omitempty"`
	// ActionDetails - The list of action detail
	ActionDetails *[]ActionDetail `json:"ActionDetails,omitempty"`
}

TestNotificationDetailsResponse the details of the test notification results.

type TestNotificationResponse

type TestNotificationResponse struct {
	autorest.Response `json:"-"`
	// NotificationID - The notification id
	NotificationID *string `json:"notificationId,omitempty"`
	// CorrelationID - The correlation id
	CorrelationID *string `json:"correlationId,omitempty"`
	// CreatedTime - The created time
	CreatedTime *string `json:"createdTime,omitempty"`
}

TestNotificationResponse the response when test notification succeeded

type VoiceReceiver

type VoiceReceiver struct {
	// Name - The name of the voice receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// CountryCode - The country code of the voice receiver.
	CountryCode *string `json:"countryCode,omitempty"`
	// PhoneNumber - The phone number of the voice receiver.
	PhoneNumber *string `json:"phoneNumber,omitempty"`
}

VoiceReceiver a voice receiver.

type WebhookReceiver

type WebhookReceiver struct {
	// Name - The name of the webhook receiver. Names must be unique across all receivers within an action group.
	Name *string `json:"name,omitempty"`
	// ServiceURI - The URI where webhooks should be sent.
	ServiceURI *string `json:"serviceUri,omitempty"`
	// UseCommonAlertSchema - Indicates whether to use common alert schema.
	UseCommonAlertSchema *bool `json:"useCommonAlertSchema,omitempty"`
	// UseAadAuth - Indicates whether or not use AAD authentication.
	UseAadAuth *bool `json:"useAadAuth,omitempty"`
	// ObjectID - Indicates the webhook app object Id for aad auth.
	ObjectID *string `json:"objectId,omitempty"`
	// IdentifierURI - Indicates the identifier uri for aad auth.
	IdentifierURI *string `json:"identifierUri,omitempty"`
	// TenantID - Indicates the tenant id for aad auth.
	TenantID *string `json:"tenantId,omitempty"`
}

WebhookReceiver a webhook receiver.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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