senderusernames

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-03-31/senderusernames Documentation

The senderusernames SDK allows for interaction with Azure Resource Manager communication (API Version 2023-03-31).

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/communication/2023-03-31/senderusernames"

Client Initialization

client := senderusernames.NewSenderUsernamesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SenderUsernamesClient.CreateOrUpdate

ctx := context.TODO()
id := senderusernames.NewSenderUsernameID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceName", "domainName", "senderUsername")

payload := senderusernames.SenderUsernameResource{
	// ...
}


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

Example Usage: SenderUsernamesClient.Delete

ctx := context.TODO()
id := senderusernames.NewSenderUsernameID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceName", "domainName", "senderUsername")

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: SenderUsernamesClient.Get

ctx := context.TODO()
id := senderusernames.NewSenderUsernameID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceName", "domainName", "senderUsername")

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

Example Usage: SenderUsernamesClient.ListByDomains

ctx := context.TODO()
id := senderusernames.NewDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceName", "domainName")

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

func PossibleValuesForProvisioningState() []string

func ValidateDomainID 

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

ValidateDomainID checks that 'input' can be parsed as a Domain ID

func ValidateSenderUsernameID 

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

ValidateSenderUsernameID checks that 'input' can be parsed as a Sender Username ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type DomainId 

type DomainId struct {
	SubscriptionId    string
	ResourceGroupName string
	EmailServiceName  string
	DomainName        string
}

DomainId is a struct representing the Resource ID for a Domain

func NewDomainID 

func NewDomainID(subscriptionId string, resourceGroupName string, emailServiceName string, domainName string) DomainId

NewDomainID returns a new DomainId struct

func ParseDomainID 

func ParseDomainID(input string) (*DomainId, error)

ParseDomainID parses 'input' into a DomainId

func ParseDomainIDInsensitively 

func ParseDomainIDInsensitively(input string) (*DomainId, error)

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

func (*DomainId) FromParseResult 

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

func (DomainId) ID 

func (id DomainId) ID() string

ID returns the formatted Domain ID

func (DomainId) Segments 

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

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

func (DomainId) String 

func (id DomainId) String() string

String returns a human-readable description of this Domain ID

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SenderUsernameResource
}

type ListByDomainsCompleteResult 

type ListByDomainsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SenderUsernameResource
}

type ListByDomainsCustomPager added in v0.20240628.1153531 

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

type ListByDomainsOperationResponse 

type ListByDomainsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SenderUsernameResource
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUnknown   ProvisioningState = "Unknown"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type SenderUsernameId 

type SenderUsernameId struct {
	SubscriptionId     string
	ResourceGroupName  string
	EmailServiceName   string
	DomainName         string
	SenderUsernameName string
}

SenderUsernameId is a struct representing the Resource ID for a Sender Username

func NewSenderUsernameID 

func NewSenderUsernameID(subscriptionId string, resourceGroupName string, emailServiceName string, domainName string, senderUsernameName string) SenderUsernameId

NewSenderUsernameID returns a new SenderUsernameId struct

func ParseSenderUsernameID 

func ParseSenderUsernameID(input string) (*SenderUsernameId, error)

ParseSenderUsernameID parses 'input' into a SenderUsernameId

func ParseSenderUsernameIDInsensitively 

func ParseSenderUsernameIDInsensitively(input string) (*SenderUsernameId, error)

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

func (*SenderUsernameId) FromParseResult 

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

func (SenderUsernameId) ID 

func (id SenderUsernameId) ID() string

ID returns the formatted Sender Username ID

func (SenderUsernameId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Sender Username ID

func (SenderUsernameId) String 

func (id SenderUsernameId) String() string

String returns a human-readable description of this Sender Username ID

type SenderUsernameProperties 

type SenderUsernameProperties struct {
	DataLocation      *string            `json:"dataLocation,omitempty"`
	DisplayName       *string            `json:"displayName,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	Username          string             `json:"username"`
}

type SenderUsernameResource 

type SenderUsernameResource struct {
	Id         *string                   `json:"id,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *SenderUsernameProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type SenderUsernameResourceOperationPredicate 

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

func (SenderUsernameResourceOperationPredicate) Matches 

func (p SenderUsernameResourceOperationPredicate) Matches(input SenderUsernameResource) bool

type SenderUsernamesClient 

type SenderUsernamesClient struct {
	Client *resourcemanager.Client
}

func NewSenderUsernamesClientWithBaseURI 

func NewSenderUsernamesClientWithBaseURI(sdkApi sdkEnv.Api) (*SenderUsernamesClient, error)

func (SenderUsernamesClient) CreateOrUpdate 

func (c SenderUsernamesClient) CreateOrUpdate(ctx context.Context, id SenderUsernameId, input SenderUsernameResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SenderUsernamesClient) Delete 

func (c SenderUsernamesClient) Delete(ctx context.Context, id SenderUsernameId) (result DeleteOperationResponse, err error)

Delete ...

func (SenderUsernamesClient) Get 

func (c SenderUsernamesClient) Get(ctx context.Context, id SenderUsernameId) (result GetOperationResponse, err error)

Get ...

func (SenderUsernamesClient) ListByDomains 

func (c SenderUsernamesClient) ListByDomains(ctx context.Context, id DomainId) (result ListByDomainsOperationResponse, err error)

ListByDomains ...

func (SenderUsernamesClient) ListByDomainsComplete 

func (c SenderUsernamesClient) ListByDomainsComplete(ctx context.Context, id DomainId) (ListByDomainsCompleteResult, error)

ListByDomainsComplete retrieves all the results into a single object

func (SenderUsernamesClient) ListByDomainsCompleteMatchingPredicate 

func (c SenderUsernamesClient) ListByDomainsCompleteMatchingPredicate(ctx context.Context, id DomainId, predicate SenderUsernameResourceOperationPredicate) (result ListByDomainsCompleteResult, err error)

ListByDomainsCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.