emailtemplates

package
v0.20240524.1090207 Latest Latest
Warning

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

Go to latest
Published: May 24, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/emailtemplates Documentation

The emailtemplates SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-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/2022-08-01/emailtemplates"

Client Initialization

client := emailtemplates.NewEmailTemplatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EmailTemplatesClient.EmailTemplateCreateOrUpdate

ctx := context.TODO()
id := emailtemplates.NewTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "accountClosedDeveloper")

payload := emailtemplates.EmailTemplateUpdateParameters{
	// ...
}


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

Example Usage: EmailTemplatesClient.EmailTemplateDelete

ctx := context.TODO()
id := emailtemplates.NewTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "accountClosedDeveloper")

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

Example Usage: EmailTemplatesClient.EmailTemplateGet

ctx := context.TODO()
id := emailtemplates.NewTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "accountClosedDeveloper")

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

Example Usage: EmailTemplatesClient.EmailTemplateGetEntityTag

ctx := context.TODO()
id := emailtemplates.NewTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "accountClosedDeveloper")

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

Example Usage: EmailTemplatesClient.EmailTemplateUpdate

ctx := context.TODO()
id := emailtemplates.NewTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "accountClosedDeveloper")

payload := emailtemplates.EmailTemplateUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForTemplateName

func PossibleValuesForTemplateName() []string

func ValidateTemplateID

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

ValidateTemplateID checks that 'input' can be parsed as a Template ID

Types

type EmailTemplateContract

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

type EmailTemplateContractProperties

type EmailTemplateContractProperties struct {
	Body        string                                       `json:"body"`
	Description *string                                      `json:"description,omitempty"`
	IsDefault   *bool                                        `json:"isDefault,omitempty"`
	Parameters  *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
	Subject     string                                       `json:"subject"`
	Title       *string                                      `json:"title,omitempty"`
}

type EmailTemplateCreateOrUpdateOperationOptions

type EmailTemplateCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultEmailTemplateCreateOrUpdateOperationOptions

func DefaultEmailTemplateCreateOrUpdateOperationOptions() EmailTemplateCreateOrUpdateOperationOptions

func (EmailTemplateCreateOrUpdateOperationOptions) ToHeaders

func (EmailTemplateCreateOrUpdateOperationOptions) ToOData

func (EmailTemplateCreateOrUpdateOperationOptions) ToQuery

type EmailTemplateCreateOrUpdateOperationResponse

type EmailTemplateCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EmailTemplateContract
}

type EmailTemplateDeleteOperationOptions

type EmailTemplateDeleteOperationOptions struct {
	IfMatch *string
}

func DefaultEmailTemplateDeleteOperationOptions

func DefaultEmailTemplateDeleteOperationOptions() EmailTemplateDeleteOperationOptions

func (EmailTemplateDeleteOperationOptions) ToHeaders

func (EmailTemplateDeleteOperationOptions) ToOData

func (EmailTemplateDeleteOperationOptions) ToQuery

type EmailTemplateDeleteOperationResponse

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

type EmailTemplateGetEntityTagOperationResponse

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

type EmailTemplateGetOperationResponse

type EmailTemplateGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EmailTemplateContract
}

type EmailTemplateParametersContractProperties

type EmailTemplateParametersContractProperties struct {
	Description *string `json:"description,omitempty"`
	Name        *string `json:"name,omitempty"`
	Title       *string `json:"title,omitempty"`
}

type EmailTemplateUpdateOperationOptions

type EmailTemplateUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultEmailTemplateUpdateOperationOptions

func DefaultEmailTemplateUpdateOperationOptions() EmailTemplateUpdateOperationOptions

func (EmailTemplateUpdateOperationOptions) ToHeaders

func (EmailTemplateUpdateOperationOptions) ToOData

func (EmailTemplateUpdateOperationOptions) ToQuery

type EmailTemplateUpdateOperationResponse

type EmailTemplateUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EmailTemplateContract
}

type EmailTemplateUpdateParameterProperties

type EmailTemplateUpdateParameterProperties struct {
	Body        *string                                      `json:"body,omitempty"`
	Description *string                                      `json:"description,omitempty"`
	Parameters  *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
	Subject     *string                                      `json:"subject,omitempty"`
	Title       *string                                      `json:"title,omitempty"`
}

type EmailTemplateUpdateParameters

type EmailTemplateUpdateParameters struct {
	Properties *EmailTemplateUpdateParameterProperties `json:"properties,omitempty"`
}

type EmailTemplatesClient

type EmailTemplatesClient struct {
	Client *resourcemanager.Client
}

func NewEmailTemplatesClientWithBaseURI

func NewEmailTemplatesClientWithBaseURI(sdkApi sdkEnv.Api) (*EmailTemplatesClient, error)

func (EmailTemplatesClient) EmailTemplateCreateOrUpdate

EmailTemplateCreateOrUpdate ...

func (EmailTemplatesClient) EmailTemplateDelete

EmailTemplateDelete ...

func (EmailTemplatesClient) EmailTemplateGet

func (c EmailTemplatesClient) EmailTemplateGet(ctx context.Context, id TemplateId) (result EmailTemplateGetOperationResponse, err error)

EmailTemplateGet ...

func (EmailTemplatesClient) EmailTemplateGetEntityTag

func (c EmailTemplatesClient) EmailTemplateGetEntityTag(ctx context.Context, id TemplateId) (result EmailTemplateGetEntityTagOperationResponse, err error)

EmailTemplateGetEntityTag ...

func (EmailTemplatesClient) EmailTemplateUpdate

EmailTemplateUpdate ...

type TemplateId

type TemplateId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	TemplateName      TemplateName
}

TemplateId is a struct representing the Resource ID for a Template

func NewTemplateID

func NewTemplateID(subscriptionId string, resourceGroupName string, serviceName string, templateName TemplateName) TemplateId

NewTemplateID returns a new TemplateId struct

func ParseTemplateID

func ParseTemplateID(input string) (*TemplateId, error)

ParseTemplateID parses 'input' into a TemplateId

func ParseTemplateIDInsensitively

func ParseTemplateIDInsensitively(input string) (*TemplateId, error)

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

func (*TemplateId) FromParseResult

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

func (TemplateId) ID

func (id TemplateId) ID() string

ID returns the formatted Template ID

func (TemplateId) Segments

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

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

func (TemplateId) String

func (id TemplateId) String() string

String returns a human-readable description of this Template ID

type TemplateName

type TemplateName string
const (
	TemplateNameAccountClosedDeveloper                            TemplateName = "accountClosedDeveloper"
	TemplateNameApplicationApprovedNotificationMessage            TemplateName = "applicationApprovedNotificationMessage"
	TemplateNameConfirmSignUpIdentityDefault                      TemplateName = "confirmSignUpIdentityDefault"
	TemplateNameEmailChangeIdentityDefault                        TemplateName = "emailChangeIdentityDefault"
	TemplateNameInviteUserNotificationMessage                     TemplateName = "inviteUserNotificationMessage"
	TemplateNameNewCommentNotificationMessage                     TemplateName = "newCommentNotificationMessage"
	TemplateNameNewDeveloperNotificationMessage                   TemplateName = "newDeveloperNotificationMessage"
	TemplateNameNewIssueNotificationMessage                       TemplateName = "newIssueNotificationMessage"
	TemplateNamePasswordResetByAdminNotificationMessage           TemplateName = "passwordResetByAdminNotificationMessage"
	TemplateNamePasswordResetIdentityDefault                      TemplateName = "passwordResetIdentityDefault"
	TemplateNamePurchaseDeveloperNotificationMessage              TemplateName = "purchaseDeveloperNotificationMessage"
	TemplateNameQuotaLimitApproachingDeveloperNotificationMessage TemplateName = "quotaLimitApproachingDeveloperNotificationMessage"
	TemplateNameRejectDeveloperNotificationMessage                TemplateName = "rejectDeveloperNotificationMessage"
	TemplateNameRequestDeveloperNotificationMessage               TemplateName = "requestDeveloperNotificationMessage"
)

func (*TemplateName) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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