notificationrecipientuser

package
v0.20240320.1144505 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-03-01-preview/notificationrecipientuser Documentation

The notificationrecipientuser SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-03-01-preview).

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/2023-03-01-preview/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")

// 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
}

Example Usage: NotificationRecipientUserClient.WorkspaceNotificationRecipientUserCheckEntityExists

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

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

Example Usage: NotificationRecipientUserClient.WorkspaceNotificationRecipientUserCreateOrUpdate

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

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

Example Usage: NotificationRecipientUserClient.WorkspaceNotificationRecipientUserDelete

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

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

Example Usage: NotificationRecipientUserClient.WorkspaceNotificationRecipientUserListByNotification

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

// alternatively `client.WorkspaceNotificationRecipientUserListByNotification(ctx, id)` can be used to do batched pagination
items, err := client.WorkspaceNotificationRecipientUserListByNotificationComplete(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 ValidateNotificationNotificationID 

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

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

func ValidateNotificationRecipientUserID 

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

ValidateNotificationRecipientUserID checks that 'input' can be parsed as a Notification Recipient User 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 ListByNotificationCompleteResult added in v0.20240226.1173038 

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

type ListByNotificationOperationResponse 

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

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 NotificationNotificationId 

type NotificationNotificationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	NotificationName  NotificationName
}

NotificationNotificationId is a struct representing the Resource ID for a Notification Notification

func NewNotificationNotificationID 

func NewNotificationNotificationID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, notificationName NotificationName) NotificationNotificationId

NewNotificationNotificationID returns a new NotificationNotificationId struct

func ParseNotificationNotificationID 

func ParseNotificationNotificationID(input string) (*NotificationNotificationId, error)

ParseNotificationNotificationID parses 'input' into a NotificationNotificationId

func ParseNotificationNotificationIDInsensitively 

func ParseNotificationNotificationIDInsensitively(input string) (*NotificationNotificationId, error)

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

func (*NotificationNotificationId) FromParseResult 

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

func (NotificationNotificationId) ID 

func (id NotificationNotificationId) ID() string

ID returns the formatted Notification Notification ID

func (NotificationNotificationId) Segments 

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

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

func (NotificationNotificationId) String 

func (id NotificationNotificationId) String() string

String returns a human-readable description of this Notification Notification ID

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

func (NotificationRecipientUserClient) ListByNotificationComplete added in v0.20240226.1173038 

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

ListByNotificationComplete retrieves all the results into a single object

func (NotificationRecipientUserClient) ListByNotificationCompleteMatchingPredicate added in v0.20240226.1173038 

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

ListByNotificationCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NotificationRecipientUserClient) WorkspaceNotificationRecipientUserCheckEntityExists 

func (c NotificationRecipientUserClient) WorkspaceNotificationRecipientUserCheckEntityExists(ctx context.Context, id NotificationRecipientUserId) (result WorkspaceNotificationRecipientUserCheckEntityExistsOperationResponse, err error)

WorkspaceNotificationRecipientUserCheckEntityExists ...

func (NotificationRecipientUserClient) WorkspaceNotificationRecipientUserCreateOrUpdate 

func (c NotificationRecipientUserClient) WorkspaceNotificationRecipientUserCreateOrUpdate(ctx context.Context, id NotificationRecipientUserId) (result WorkspaceNotificationRecipientUserCreateOrUpdateOperationResponse, err error)

WorkspaceNotificationRecipientUserCreateOrUpdate ...

func (NotificationRecipientUserClient) WorkspaceNotificationRecipientUserDelete 

func (c NotificationRecipientUserClient) WorkspaceNotificationRecipientUserDelete(ctx context.Context, id NotificationRecipientUserId) (result WorkspaceNotificationRecipientUserDeleteOperationResponse, err error)

WorkspaceNotificationRecipientUserDelete ...

func (NotificationRecipientUserClient) WorkspaceNotificationRecipientUserListByNotification 

func (c NotificationRecipientUserClient) WorkspaceNotificationRecipientUserListByNotification(ctx context.Context, id NotificationNotificationId) (result WorkspaceNotificationRecipientUserListByNotificationOperationResponse, err error)

WorkspaceNotificationRecipientUserListByNotification ...

func (NotificationRecipientUserClient) WorkspaceNotificationRecipientUserListByNotificationComplete added in v0.20240226.1173038 

func (c NotificationRecipientUserClient) WorkspaceNotificationRecipientUserListByNotificationComplete(ctx context.Context, id NotificationNotificationId) (WorkspaceNotificationRecipientUserListByNotificationCompleteResult, error)

WorkspaceNotificationRecipientUserListByNotificationComplete retrieves all the results into a single object

func (NotificationRecipientUserClient) WorkspaceNotificationRecipientUserListByNotificationCompleteMatchingPredicate added in v0.20240226.1173038 

func (c NotificationRecipientUserClient) WorkspaceNotificationRecipientUserListByNotificationCompleteMatchingPredicate(ctx context.Context, id NotificationNotificationId, predicate RecipientUserContractOperationPredicate) (result WorkspaceNotificationRecipientUserListByNotificationCompleteResult, err error)

WorkspaceNotificationRecipientUserListByNotificationCompleteMatchingPredicate retrieves all the results and then applies the predicate

type NotificationRecipientUserId 

type NotificationRecipientUserId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	NotificationName  NotificationName
	UserId            string
}

NotificationRecipientUserId is a struct representing the Resource ID for a Notification Recipient User

func NewNotificationRecipientUserID 

func NewNotificationRecipientUserID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, notificationName NotificationName, userId string) NotificationRecipientUserId

NewNotificationRecipientUserID returns a new NotificationRecipientUserId struct

func ParseNotificationRecipientUserID 

func ParseNotificationRecipientUserID(input string) (*NotificationRecipientUserId, error)

ParseNotificationRecipientUserID parses 'input' into a NotificationRecipientUserId

func ParseNotificationRecipientUserIDInsensitively 

func ParseNotificationRecipientUserIDInsensitively(input string) (*NotificationRecipientUserId, error)

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

func (*NotificationRecipientUserId) FromParseResult 

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

func (NotificationRecipientUserId) ID 

func (id NotificationRecipientUserId) ID() string

ID returns the formatted Notification Recipient User ID

func (NotificationRecipientUserId) Segments 

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

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

func (NotificationRecipientUserId) String 

func (id NotificationRecipientUserId) String() string

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

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

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

func (RecipientUserContractOperationPredicate) Matches added in v0.20240226.1173038 

func (p RecipientUserContractOperationPredicate) Matches(input RecipientUserContract) bool

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

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

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

type WorkspaceNotificationRecipientUserCheckEntityExistsOperationResponse 

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

type WorkspaceNotificationRecipientUserCreateOrUpdateOperationResponse 

type WorkspaceNotificationRecipientUserCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RecipientUserContract
}

type WorkspaceNotificationRecipientUserDeleteOperationResponse 

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

type WorkspaceNotificationRecipientUserListByNotificationCompleteResult added in v0.20240226.1173038 

type WorkspaceNotificationRecipientUserListByNotificationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RecipientUserContract
}

type WorkspaceNotificationRecipientUserListByNotificationOperationResponse 

type WorkspaceNotificationRecipientUserListByNotificationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RecipientUserContract
}

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.