EmailTemplatesClient Interface

Package:

com.azure.resourcemanager.apimanagement.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:2.0.0

public interface EmailTemplatesClient

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

Method Summary

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

Method Details

createOrUpdate

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

Updates an Email Template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

parameters - Email Template update parameters.

Returns:

email Template details.

createOrUpdateWithResponse

public abstract Response<EmailTemplateContractInner> createOrUpdateWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, EmailTemplateUpdateParameters parameters, String ifMatch, Context context)

Updates an Email Template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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<T>.

delete

public abstract 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. The name is case insensitive.

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.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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<T>.

get

public abstract 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. The name is case insensitive.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

Returns:

the details of the email template specified by its identifier.

getEntityTag

public abstract 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. The name is case insensitive.

serviceName - The name of the API Management service.

templateName - Email Template Name Identifier.

getEntityTagWithResponse

public abstract EmailTemplatesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

getWithResponse

public abstract EmailTemplatesGetResponse getWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

listByService

public abstract PagedIterable<EmailTemplateContractInner> listByService(String resourceGroupName, String serviceName)

Gets all email templates.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

all email templates as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable<EmailTemplateContractInner> listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Gets all email templates.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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<T>.

update

public abstract 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. The name is case insensitive.

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.

updateWithResponse

public abstract EmailTemplatesUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch, EmailTemplateUpdateParameters parameters, Context context)

Updates API Management email template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.