README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/emailtemplate
Documentation
The emailtemplate
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/emailtemplate"
Client Initialization
client := emailtemplate.NewEmailTemplateClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: EmailTemplateClient.ListByService
ctx := context.TODO()
id := emailtemplate.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
// alternatively `client.ListByService(ctx, id, emailtemplate.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, emailtemplate.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type EmailTemplateClient
- func (c EmailTemplateClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c EmailTemplateClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c EmailTemplateClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
- type EmailTemplateContract
- type EmailTemplateContractOperationPredicate
- type EmailTemplateContractProperties
- type EmailTemplateParametersContractProperties
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type ServiceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type EmailTemplateClient ¶
type EmailTemplateClient struct {
Client *resourcemanager.Client
}
func NewEmailTemplateClientWithBaseURI ¶
func NewEmailTemplateClientWithBaseURI(sdkApi sdkEnv.Api) (*EmailTemplateClient, error)
func (EmailTemplateClient) ListByService ¶
func (c EmailTemplateClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (EmailTemplateClient) ListByServiceComplete ¶
func (c EmailTemplateClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (EmailTemplateClient) ListByServiceCompleteMatchingPredicate ¶
func (c EmailTemplateClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate EmailTemplateContractOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate
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 EmailTemplateContractOperationPredicate ¶
func (EmailTemplateContractOperationPredicate) Matches ¶
func (p EmailTemplateContractOperationPredicate) Matches(input EmailTemplateContract) bool
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 ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct {
Items []EmailTemplateContract
}
type ListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
func (ListByServiceOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]EmailTemplateContract }
type ServiceId ¶
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
ParseServiceIDInsensitively parses 'input' case-insensitively into a ServiceId note: this method should only be used for API response data and not user input
func (ServiceId) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID