emailservices

package
v0.20231116.1162710 Latest Latest
Warning

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

Go to latest
Published: Nov 16, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-04-01/emailservices Documentation

The emailservices SDK allows for interaction with the Azure Resource Manager Service communication (API Version 2023-04-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/communication/2023-04-01/emailservices"

Client Initialization

client := emailservices.NewEmailServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EmailServicesClient.CreateOrUpdate

ctx := context.TODO()
id := emailservices.NewEmailServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceValue")

payload := emailservices.EmailServiceResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: EmailServicesClient.Delete

ctx := context.TODO()
id := emailservices.NewEmailServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: EmailServicesClient.Get

ctx := context.TODO()
id := emailservices.NewEmailServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceValue")

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: EmailServicesClient.ListByResourceGroup

ctx := context.TODO()
id := emailservices.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: EmailServicesClient.ListBySubscription

ctx := context.TODO()
id := emailservices.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: EmailServicesClient.ListVerifiedExchangeOnlineDomains

ctx := context.TODO()
id := emailservices.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: EmailServicesClient.Update

ctx := context.TODO()
id := emailservices.NewEmailServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "emailServiceValue")

payload := emailservices.TaggedResource{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEmailServicesProvisioningState

func PossibleValuesForEmailServicesProvisioningState() []string

func ValidateEmailServiceID

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

ValidateEmailServiceID checks that 'input' can be parsed as a Email Service ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse

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

type EmailServiceId

type EmailServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	EmailServiceName  string
}

EmailServiceId is a struct representing the Resource ID for a Email Service

func NewEmailServiceID

func NewEmailServiceID(subscriptionId string, resourceGroupName string, emailServiceName string) EmailServiceId

NewEmailServiceID returns a new EmailServiceId struct

func ParseEmailServiceID

func ParseEmailServiceID(input string) (*EmailServiceId, error)

ParseEmailServiceID parses 'input' into a EmailServiceId

func ParseEmailServiceIDInsensitively

func ParseEmailServiceIDInsensitively(input string) (*EmailServiceId, error)

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

func (EmailServiceId) ID

func (id EmailServiceId) ID() string

ID returns the formatted Email Service ID

func (EmailServiceId) Segments

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

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

func (EmailServiceId) String

func (id EmailServiceId) String() string

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

type EmailServiceProperties

type EmailServiceProperties struct {
	DataLocation      string                          `json:"dataLocation"`
	ProvisioningState *EmailServicesProvisioningState `json:"provisioningState,omitempty"`
}

type EmailServiceResource

type EmailServiceResource struct {
	Id         *string                 `json:"id,omitempty"`
	Location   string                  `json:"location"`
	Name       *string                 `json:"name,omitempty"`
	Properties *EmailServiceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Tags       *map[string]string      `json:"tags,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type EmailServiceResourceOperationPredicate

type EmailServiceResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (EmailServiceResourceOperationPredicate) Matches

type EmailServicesClient

type EmailServicesClient struct {
	Client *resourcemanager.Client
}

func NewEmailServicesClientWithBaseURI

func NewEmailServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*EmailServicesClient, error)

func (EmailServicesClient) CreateOrUpdate

CreateOrUpdate ...

func (EmailServicesClient) CreateOrUpdateThenPoll

func (c EmailServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id EmailServiceId, input EmailServiceResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (EmailServicesClient) Delete

Delete ...

func (EmailServicesClient) DeleteThenPoll

func (c EmailServicesClient) DeleteThenPoll(ctx context.Context, id EmailServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (EmailServicesClient) Get

Get ...

func (EmailServicesClient) ListByResourceGroup

ListByResourceGroup ...

func (EmailServicesClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (EmailServicesClient) ListByResourceGroupCompleteMatchingPredicate

func (c EmailServicesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate EmailServiceResourceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EmailServicesClient) ListBySubscription

ListBySubscription ...

func (EmailServicesClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (EmailServicesClient) ListBySubscriptionCompleteMatchingPredicate

func (c EmailServicesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate EmailServiceResourceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EmailServicesClient) ListVerifiedExchangeOnlineDomains

func (c EmailServicesClient) ListVerifiedExchangeOnlineDomains(ctx context.Context, id commonids.SubscriptionId) (result ListVerifiedExchangeOnlineDomainsOperationResponse, err error)

ListVerifiedExchangeOnlineDomains ...

func (EmailServicesClient) Update

Update ...

func (EmailServicesClient) UpdateThenPoll

func (c EmailServicesClient) UpdateThenPoll(ctx context.Context, id EmailServiceId, input TaggedResource) error

UpdateThenPoll performs Update then polls until it's completed

type EmailServicesProvisioningState

type EmailServicesProvisioningState string
const (
	EmailServicesProvisioningStateCanceled  EmailServicesProvisioningState = "Canceled"
	EmailServicesProvisioningStateCreating  EmailServicesProvisioningState = "Creating"
	EmailServicesProvisioningStateDeleting  EmailServicesProvisioningState = "Deleting"
	EmailServicesProvisioningStateFailed    EmailServicesProvisioningState = "Failed"
	EmailServicesProvisioningStateMoving    EmailServicesProvisioningState = "Moving"
	EmailServicesProvisioningStateRunning   EmailServicesProvisioningState = "Running"
	EmailServicesProvisioningStateSucceeded EmailServicesProvisioningState = "Succeeded"
	EmailServicesProvisioningStateUnknown   EmailServicesProvisioningState = "Unknown"
	EmailServicesProvisioningStateUpdating  EmailServicesProvisioningState = "Updating"
)

func (*EmailServicesProvisioningState) UnmarshalJSON

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

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []EmailServiceResource
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EmailServiceResource
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []EmailServiceResource
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EmailServiceResource
}

type ListVerifiedExchangeOnlineDomainsOperationResponse

type ListVerifiedExchangeOnlineDomainsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type TaggedResource

type TaggedResource struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL