Package com.azure.resourcemanager.apimanagement.fluent

Interface EmailTemplatesClient

public interface EmailTemplatesClient

An instance of this class provides access to all the operations defined in EmailTemplatesClient.

Method Summary

Modifier and Type	Method	Description
EmailTemplateContractInner	createOrUpdate(String resourceGroupName, String serviceName, TemplateName templateName, EmailTemplateUpdateParameters parameters)	Updates an Email Template.
com.azure.core.http.rest.Response<EmailTemplateContractInner>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, EmailTemplateUpdateParameters parameters, String ifMatch, com.azure.core.util.Context context)	Updates an Email Template.
void	delete(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch)	Reset the Email Template to default template provided by the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch, com.azure.core.util.Context context)	Reset the Email Template to default template provided by the API Management service instance.
EmailTemplateContractInner	get(String resourceGroupName, String serviceName, TemplateName templateName)	Gets the details of the email template specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, TemplateName templateName)	Gets the entity state (Etag) version of the email template specified by its identifier.
EmailTemplatesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the email template specified by its identifier.
EmailTemplatesGetResponse	getWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, com.azure.core.util.Context context)	Gets the details of the email template specified by its identifier.
com.azure.core.http.rest.PagedIterable<EmailTemplateContractInner>	listByService(String resourceGroupName, String serviceName)	Gets all email templates.
com.azure.core.http.rest.PagedIterable<EmailTemplateContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Gets all email templates.
EmailTemplateContractInner	update(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch, EmailTemplateUpdateParameters parameters)	Updates API Management email template.
EmailTemplatesUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch, EmailTemplateUpdateParameters parameters, com.azure.core.util.Context context)	Updates API Management email template.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<EmailTemplateContractInner> listByService(String resourceGroupName,
                                                                                 String serviceName)

Gets all email templates.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

all email templates as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByService

com.azure.core.http.rest.PagedIterable<EmailTemplateContractInner> listByService(String resourceGroupName,
                                                                                 String serviceName,
                                                                                 String filter,
                                                                                 Integer top,
                                                                                 Integer skip,
                                                                                 com.azure.core.util.Context context)

Gets all email templates.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

all email templates as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName,
                  TemplateName templateName)

Gets the entity state (Etag) version of the email template specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTagWithResponse

EmailTemplatesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                            String serviceName,
                                                            TemplateName templateName,
                                                            com.azure.core.util.Context context)

Gets the entity state (Etag) version of the email template specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the email template specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

EmailTemplateContractInner get(String resourceGroupName,
                               String serviceName,
                               TemplateName templateName)

Gets the details of the email template specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

Returns:

the details of the email template specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

EmailTemplatesGetResponse getWithResponse(String resourceGroupName,
                                          String serviceName,
                                          TemplateName templateName,
                                          com.azure.core.util.Context context)

Gets the details of the email template specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

context - The context to associate with this operation.

Returns:

the details of the email template specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

EmailTemplateContractInner createOrUpdate(String resourceGroupName,
                                          String serviceName,
                                          TemplateName templateName,
                                          EmailTemplateUpdateParameters parameters)

Updates an Email Template.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

parameters - Email Template update parameters.

Returns:

email Template details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<EmailTemplateContractInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                         String serviceName,
                                                                                         TemplateName templateName,
                                                                                         EmailTemplateUpdateParameters parameters,
                                                                                         String ifMatch,
                                                                                         com.azure.core.util.Context context)

Updates an Email Template.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

parameters - Email Template update parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

email Template details along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

EmailTemplateContractInner update(String resourceGroupName,
                                  String serviceName,
                                  TemplateName templateName,
                                  String ifMatch,
                                  EmailTemplateUpdateParameters parameters)

Updates API Management email template.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters - Update parameters.

Returns:

email Template details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

EmailTemplatesUpdateResponse updateWithResponse(String resourceGroupName,
                                                String serviceName,
                                                TemplateName templateName,
                                                String ifMatch,
                                                EmailTemplateUpdateParameters parameters,
                                                com.azure.core.util.Context context)

Updates API Management email template.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters - Update parameters.

context - The context to associate with this operation.

Returns:

email Template details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String serviceName,
            TemplateName templateName,
            String ifMatch)

Reset the Email Template to default template provided by the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           TemplateName templateName,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Reset the Email Template to default template provided by the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.