notificationrecipientemail

README

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

The notificationrecipientemail SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2021-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/2021-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", "serviceValue", "AccountClosedPublisher", "recipientEmailValue")

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", "serviceValue", "AccountClosedPublisher", "recipientEmailValue")

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", "serviceValue", "AccountClosedPublisher", "recipientEmailValue")

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", "serviceValue", "AccountClosedPublisher")

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

Documentation

Index

• func PossibleValuesForNotificationName() []string
• func ValidateNotificationID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateRecipientEmailID(input interface{}, key string) (warnings []string, errors []error)
• type CheckEntityExistsOperationResponse
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type ListByNotificationOperationResponse
• type NotificationId
  • func NewNotificationID(subscriptionId string, resourceGroupName string, serviceName string, ...) NotificationId
  • func ParseNotificationID(input string) (*NotificationId, error)
  • func ParseNotificationIDInsensitively(input string) (*NotificationId, error)
  • func (id NotificationId) ID() string
  • func (id NotificationId) Segments() []resourceids.Segment
  • func (id NotificationId) String() string
• type NotificationName
  • func (s *NotificationName) UnmarshalJSON(bytes []byte) error
• type NotificationRecipientEmailClient
  • func NewNotificationRecipientEmailClientWithBaseURI(sdkApi sdkEnv.Api) (*NotificationRecipientEmailClient, error)
  • func (c NotificationRecipientEmailClient) CheckEntityExists(ctx context.Context, id RecipientEmailId) (result CheckEntityExistsOperationResponse, err error)
  • func (c NotificationRecipientEmailClient) CreateOrUpdate(ctx context.Context, id RecipientEmailId) (result CreateOrUpdateOperationResponse, err error)
  • func (c NotificationRecipientEmailClient) Delete(ctx context.Context, id RecipientEmailId) (result DeleteOperationResponse, err error)
  • func (c NotificationRecipientEmailClient) ListByNotification(ctx context.Context, id NotificationId) (result ListByNotificationOperationResponse, err error)
• type RecipientEmailCollection
• type RecipientEmailContract
• type RecipientEmailContractProperties
• type RecipientEmailId
  • func NewRecipientEmailID(subscriptionId string, resourceGroupName string, serviceName string, ...) RecipientEmailId
  • func ParseRecipientEmailID(input string) (*RecipientEmailId, error)
  • func ParseRecipientEmailIDInsensitively(input string) (*RecipientEmailId, error)
  • func (id RecipientEmailId) ID() string
  • func (id RecipientEmailId) Segments() []resourceids.Segment
  • func (id RecipientEmailId) String() string

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 ListByNotificationOperationResponse

type ListByNotificationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RecipientEmailCollection
}

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) 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 ...

type RecipientEmailCollection

type RecipientEmailCollection struct {
	Count    *int64                    `json:"count,omitempty"`
	NextLink *string                   `json:"nextLink,omitempty"`
	Value    *[]RecipientEmailContract `json:"value,omitempty"`
}

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 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) 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