Package com.azure.resourcemanager.apimanagement.models

Interface EmailTemplates

public interface EmailTemplates

Resource collection API of EmailTemplates.

Method Summary

Modifier and Type	Method	Description
EmailTemplateContract.DefinitionStages.Blank	define(TemplateName name)	Begins definition for a new EmailTemplateContract resource.
void	delete(String resourceGroupName, String serviceName, TemplateName templateName, String ifMatch)	Reset the Email Template to default template provided by the API Management service instance.
void	deleteById(String id)	Reset the Email Template to default template provided by the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	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.
EmailTemplateContract	get(String resourceGroupName, String serviceName, TemplateName templateName)	Gets the details of the email template specified by its identifier.
EmailTemplateContract	getById(String id)	Gets the details of the email template specified by its identifier.
com.azure.core.http.rest.Response<EmailTemplateContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	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.
com.azure.core.http.rest.Response<EmailTemplateContract>	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<EmailTemplateContract>	listByService(String resourceGroupName, String serviceName)	Gets all email templates.
com.azure.core.http.rest.PagedIterable<EmailTemplateContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Gets all email templates.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<EmailTemplateContract> 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<EmailTemplateContract> 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

EmailTemplateContract 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

com.azure.core.http.rest.Response<EmailTemplateContract> 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.

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.

getById

EmailTemplateContract getById(String id)

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

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<EmailTemplateContract> getByIdWithResponse(String id,
                                                                             com.azure.core.util.Context context)

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

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

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

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               String ifMatch,
                                                               com.azure.core.util.Context context)

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

Parameters:

id - the resource ID.

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.

define

EmailTemplateContract.DefinitionStages.Blank define(TemplateName name)

Begins definition for a new EmailTemplateContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new EmailTemplateContract definition.