notificationrecipientemail

package
v0.20241205.1102105 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/notificationrecipientemail Documentation

The notificationrecipientemail SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2022-08-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/apimanagement/2022-08-01/notificationrecipientemail"

Client Initialization

client := notificationrecipientemail.NewNotificationRecipientEmailClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NotificationRecipientEmailClient.CheckEntityExists

ctx := context.TODO()
id := notificationrecipientemail.NewRecipientEmailID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "AccountClosedPublisher", "recipientEmailName")

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

Example Usage: NotificationRecipientEmailClient.CreateOrUpdate

ctx := context.TODO()
id := notificationrecipientemail.NewRecipientEmailID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "AccountClosedPublisher", "recipientEmailName")

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

Example Usage: NotificationRecipientEmailClient.Delete

ctx := context.TODO()
id := notificationrecipientemail.NewRecipientEmailID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "AccountClosedPublisher", "recipientEmailName")

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

Example Usage: NotificationRecipientEmailClient.ListByNotification

ctx := context.TODO()
id := notificationrecipientemail.NewNotificationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "AccountClosedPublisher")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForNotificationName 

func PossibleValuesForNotificationName() []string

func ValidateNotificationID 

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

ValidateNotificationID checks that 'input' can be parsed as a Notification ID

func ValidateRecipientEmailID 

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

ValidateRecipientEmailID checks that 'input' can be parsed as a Recipient Email ID

Types

type CheckEntityExistsOperationResponse 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RecipientEmailContract
}

type DeleteOperationResponse 

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

type ListByNotificationCompleteResult added in v0.20240226.1173038 

type ListByNotificationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RecipientEmailContract
}

type ListByNotificationCustomPager added in v0.20240628.1153531 

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

type ListByNotificationOperationResponse 

type ListByNotificationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RecipientEmailContract
}

type NotificationId 

type NotificationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	NotificationName  NotificationName
}

NotificationId is a struct representing the Resource ID for a Notification

func NewNotificationID 

func NewNotificationID(subscriptionId string, resourceGroupName string, serviceName string, notificationName NotificationName) NotificationId

NewNotificationID returns a new NotificationId struct

func ParseNotificationID 

func ParseNotificationID(input string) (*NotificationId, error)

ParseNotificationID parses 'input' into a NotificationId

func ParseNotificationIDInsensitively 

func ParseNotificationIDInsensitively(input string) (*NotificationId, error)

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

func (*NotificationId) FromParseResult 

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

func (NotificationId) ID 

func (id NotificationId) ID() string

ID returns the formatted Notification ID

func (NotificationId) Segments 

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

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

func (NotificationId) String 

func (id NotificationId) String() string

String returns a human-readable description of this Notification ID

type NotificationName 

type NotificationName string
const (
	NotificationNameAccountClosedPublisher                            NotificationName = "AccountClosedPublisher"
	NotificationNameBCC                                               NotificationName = "BCC"
	NotificationNameNewApplicationNotificationMessage                 NotificationName = "NewApplicationNotificationMessage"
	NotificationNameNewIssuePublisherNotificationMessage              NotificationName = "NewIssuePublisherNotificationMessage"
	NotificationNamePurchasePublisherNotificationMessage              NotificationName = "PurchasePublisherNotificationMessage"
	NotificationNameQuotaLimitApproachingPublisherNotificationMessage NotificationName = "QuotaLimitApproachingPublisherNotificationMessage"
	NotificationNameRequestPublisherNotificationMessage               NotificationName = "RequestPublisherNotificationMessage"
)

func (*NotificationName) UnmarshalJSON 

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

type NotificationRecipientEmailClient 

type NotificationRecipientEmailClient struct {
	Client *resourcemanager.Client
}

func NewNotificationRecipientEmailClientWithBaseURI 

func NewNotificationRecipientEmailClientWithBaseURI(sdkApi sdkEnv.Api) (*NotificationRecipientEmailClient, error)

func (NotificationRecipientEmailClient) CheckEntityExists 

func (c NotificationRecipientEmailClient) CheckEntityExists(ctx context.Context, id RecipientEmailId) (result CheckEntityExistsOperationResponse, err error)

CheckEntityExists ...

func (NotificationRecipientEmailClient) CreateOrUpdate 

func (c NotificationRecipientEmailClient) CreateOrUpdate(ctx context.Context, id RecipientEmailId) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NotificationRecipientEmailClient) Delete 

func (c NotificationRecipientEmailClient) Delete(ctx context.Context, id RecipientEmailId) (result DeleteOperationResponse, err error)

Delete ...

func (NotificationRecipientEmailClient) ListByNotification 

func (c NotificationRecipientEmailClient) ListByNotification(ctx context.Context, id NotificationId) (result ListByNotificationOperationResponse, err error)

ListByNotification ...

func (NotificationRecipientEmailClient) ListByNotificationComplete added in v0.20240226.1173038 

func (c NotificationRecipientEmailClient) ListByNotificationComplete(ctx context.Context, id NotificationId) (ListByNotificationCompleteResult, error)

ListByNotificationComplete retrieves all the results into a single object

func (NotificationRecipientEmailClient) ListByNotificationCompleteMatchingPredicate added in v0.20240226.1173038 

func (c NotificationRecipientEmailClient) ListByNotificationCompleteMatchingPredicate(ctx context.Context, id NotificationId, predicate RecipientEmailContractOperationPredicate) (result ListByNotificationCompleteResult, err error)

ListByNotificationCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RecipientEmailContract 

type RecipientEmailContract struct {
	Id         *string                           `json:"id,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *RecipientEmailContractProperties `json:"properties,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type RecipientEmailContractOperationPredicate added in v0.20240226.1173038 

type RecipientEmailContractOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (RecipientEmailContractOperationPredicate) Matches added in v0.20240226.1173038 

func (p RecipientEmailContractOperationPredicate) Matches(input RecipientEmailContract) bool

type RecipientEmailContractProperties 

type RecipientEmailContractProperties struct {
	Email *string `json:"email,omitempty"`
}

type RecipientEmailId 

type RecipientEmailId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ServiceName        string
	NotificationName   NotificationName
	RecipientEmailName string
}

RecipientEmailId is a struct representing the Resource ID for a Recipient Email

func NewRecipientEmailID 

func NewRecipientEmailID(subscriptionId string, resourceGroupName string, serviceName string, notificationName NotificationName, recipientEmailName string) RecipientEmailId

NewRecipientEmailID returns a new RecipientEmailId struct

func ParseRecipientEmailID 

func ParseRecipientEmailID(input string) (*RecipientEmailId, error)

ParseRecipientEmailID parses 'input' into a RecipientEmailId

func ParseRecipientEmailIDInsensitively 

func ParseRecipientEmailIDInsensitively(input string) (*RecipientEmailId, error)

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

func (*RecipientEmailId) FromParseResult 

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

func (RecipientEmailId) ID 

func (id RecipientEmailId) ID() string

ID returns the formatted Recipient Email ID

func (RecipientEmailId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Recipient Email ID

func (RecipientEmailId) String 

func (id RecipientEmailId) String() string

String returns a human-readable description of this Recipient Email ID

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.