notificationrecipientuser

README

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

The notificationrecipientuser 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/notificationrecipientuser"

Client Initialization

client := notificationrecipientuser.NewNotificationRecipientUserClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NotificationRecipientUserClient.CheckEntityExists

ctx := context.TODO()
id := notificationrecipientuser.NewRecipientUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "AccountClosedPublisher", "userIdValue")

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: NotificationRecipientUserClient.CreateOrUpdate

ctx := context.TODO()
id := notificationrecipientuser.NewRecipientUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "AccountClosedPublisher", "userIdValue")

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: NotificationRecipientUserClient.Delete

ctx := context.TODO()
id := notificationrecipientuser.NewRecipientUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "AccountClosedPublisher", "userIdValue")

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: NotificationRecipientUserClient.ListByNotification

ctx := context.TODO()
id := notificationrecipientuser.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 ValidateRecipientUserID(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 NotificationRecipientUserClient
  • func NewNotificationRecipientUserClientWithBaseURI(sdkApi sdkEnv.Api) (*NotificationRecipientUserClient, error)
  • func (c NotificationRecipientUserClient) CheckEntityExists(ctx context.Context, id RecipientUserId) (result CheckEntityExistsOperationResponse, err error)
  • func (c NotificationRecipientUserClient) CreateOrUpdate(ctx context.Context, id RecipientUserId) (result CreateOrUpdateOperationResponse, err error)
  • func (c NotificationRecipientUserClient) Delete(ctx context.Context, id RecipientUserId) (result DeleteOperationResponse, err error)
  • func (c NotificationRecipientUserClient) ListByNotification(ctx context.Context, id NotificationId) (result ListByNotificationOperationResponse, err error)
• type RecipientUserCollection
• type RecipientUserContract
• type RecipientUserId
  • func NewRecipientUserID(subscriptionId string, resourceGroupName string, serviceName string, ...) RecipientUserId
  • func ParseRecipientUserID(input string) (*RecipientUserId, error)
  • func ParseRecipientUserIDInsensitively(input string) (*RecipientUserId, error)
  • func (id RecipientUserId) ID() string
  • func (id RecipientUserId) Segments() []resourceids.Segment
  • func (id RecipientUserId) String() string
• type RecipientUsersContractProperties

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 ValidateRecipientUserID

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

ValidateRecipientUserID checks that 'input' can be parsed as a Recipient User 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        *RecipientUserContract
}

type DeleteOperationResponse

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

type ListByNotificationOperationResponse

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

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 NotificationRecipientUserClient

type NotificationRecipientUserClient struct {
	Client *resourcemanager.Client
}

func NewNotificationRecipientUserClientWithBaseURI

func NewNotificationRecipientUserClientWithBaseURI(sdkApi sdkEnv.Api) (*NotificationRecipientUserClient, error)

func (NotificationRecipientUserClient) CheckEntityExists

func (c NotificationRecipientUserClient) CheckEntityExists(ctx context.Context, id RecipientUserId) (result CheckEntityExistsOperationResponse, err error)

CheckEntityExists ...

func (NotificationRecipientUserClient) CreateOrUpdate

func (c NotificationRecipientUserClient) CreateOrUpdate(ctx context.Context, id RecipientUserId) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NotificationRecipientUserClient) Delete

func (c NotificationRecipientUserClient) Delete(ctx context.Context, id RecipientUserId) (result DeleteOperationResponse, err error)

Delete ...

func (NotificationRecipientUserClient) ListByNotification

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

ListByNotification ...

type RecipientUserCollection

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

type RecipientUserContract

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

type RecipientUserId

type RecipientUserId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	NotificationName  NotificationName
	UserId            string
}

RecipientUserId is a struct representing the Resource ID for a Recipient User

func NewRecipientUserID

func NewRecipientUserID(subscriptionId string, resourceGroupName string, serviceName string, notificationName NotificationName, userId string) RecipientUserId

NewRecipientUserID returns a new RecipientUserId struct

func ParseRecipientUserID

func ParseRecipientUserID(input string) (*RecipientUserId, error)

ParseRecipientUserID parses 'input' into a RecipientUserId

func ParseRecipientUserIDInsensitively

func ParseRecipientUserIDInsensitively(input string) (*RecipientUserId, error)

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

func (RecipientUserId) ID

func (id RecipientUserId) ID() string

ID returns the formatted Recipient User ID

func (RecipientUserId) Segments

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

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

func (RecipientUserId) String

func (id RecipientUserId) String() string

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

type RecipientUsersContractProperties

type RecipientUsersContractProperties struct {
	UserId *string `json:"userId,omitempty"`
}