Package com.azure.resourcemanager.communication.models

Interface Domains

public interface Domains

Resource collection API of Domains.

Method Summary

Modifier and Type	Method	Description
void	cancelVerification(String resourceGroupName, String emailServiceName, String domainName, VerificationParameter parameters)	Cancel verification of DNS record.
void	cancelVerification(String resourceGroupName, String emailServiceName, String domainName, VerificationParameter parameters, com.azure.core.util.Context context)	Cancel verification of DNS record.
DomainResource.DefinitionStages.Blank	define(String name)	Begins definition for a new DomainResource resource.
void	delete(String resourceGroupName, String emailServiceName, String domainName)	Operation to delete a Domains resource.
void	delete(String resourceGroupName, String emailServiceName, String domainName, com.azure.core.util.Context context)	Operation to delete a Domains resource.
void	deleteById(String id)	Operation to delete a Domains resource.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Operation to delete a Domains resource.
DomainResource	get(String resourceGroupName, String emailServiceName, String domainName)	Get the Domains resource and its properties.
DomainResource	getById(String id)	Get the Domains resource and its properties.
com.azure.core.http.rest.Response<DomainResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the Domains resource and its properties.
com.azure.core.http.rest.Response<DomainResource>	getWithResponse(String resourceGroupName, String emailServiceName, String domainName, com.azure.core.util.Context context)	Get the Domains resource and its properties.
void	initiateVerification(String resourceGroupName, String emailServiceName, String domainName, VerificationParameter parameters)	Initiate verification of DNS record.
void	initiateVerification(String resourceGroupName, String emailServiceName, String domainName, VerificationParameter parameters, com.azure.core.util.Context context)	Initiate verification of DNS record.
com.azure.core.http.rest.PagedIterable<DomainResource>	listByEmailServiceResource(String resourceGroupName, String emailServiceName)	Handles requests to list all Domains resources under the parent EmailServices resource.
com.azure.core.http.rest.PagedIterable<DomainResource>	listByEmailServiceResource(String resourceGroupName, String emailServiceName, com.azure.core.util.Context context)	Handles requests to list all Domains resources under the parent EmailServices resource.

Method Detail

get

DomainResource get(String resourceGroupName,
                   String emailServiceName,
                   String domainName)

Get the Domains resource and its properties.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

Returns:

the Domains resource and its properties.

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<DomainResource> getWithResponse(String resourceGroupName,
                                                                  String emailServiceName,
                                                                  String domainName,
                                                                  com.azure.core.util.Context context)

Get the Domains resource and its properties.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

context - The context to associate with this operation.

Returns:

the Domains resource and its properties 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.

delete

void delete(String resourceGroupName,
            String emailServiceName,
            String domainName)

Operation to delete a Domains resource.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

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 emailServiceName,
            String domainName,
            com.azure.core.util.Context context)

Operation to delete a Domains resource.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

context - The context to associate with this operation.

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.

listByEmailServiceResource

com.azure.core.http.rest.PagedIterable<DomainResource> listByEmailServiceResource(String resourceGroupName,
                                                                                  String emailServiceName)

Handles requests to list all Domains resources under the parent EmailServices resource.

Parameters:

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

emailServiceName - The name of the EmailService resource.

Returns:

object that includes an array of Domains resource and a possible link for next set 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.

listByEmailServiceResource

com.azure.core.http.rest.PagedIterable<DomainResource> listByEmailServiceResource(String resourceGroupName,
                                                                                  String emailServiceName,
                                                                                  com.azure.core.util.Context context)

Handles requests to list all Domains resources under the parent EmailServices resource.

Parameters:

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

emailServiceName - The name of the EmailService resource.

context - The context to associate with this operation.

Returns:

object that includes an array of Domains resource and a possible link for next set 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.

initiateVerification

void initiateVerification(String resourceGroupName,
                          String emailServiceName,
                          String domainName,
                          VerificationParameter parameters)

Initiate verification of DNS record.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

parameters - Type of verification to be initiated.

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.

initiateVerification

void initiateVerification(String resourceGroupName,
                          String emailServiceName,
                          String domainName,
                          VerificationParameter parameters,
                          com.azure.core.util.Context context)

Initiate verification of DNS record.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

parameters - Type of verification to be initiated.

context - The context to associate with this operation.

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.

cancelVerification

void cancelVerification(String resourceGroupName,
                        String emailServiceName,
                        String domainName,
                        VerificationParameter parameters)

Cancel verification of DNS record.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

parameters - Type of verification to be canceled.

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.

cancelVerification

void cancelVerification(String resourceGroupName,
                        String emailServiceName,
                        String domainName,
                        VerificationParameter parameters,
                        com.azure.core.util.Context context)

Cancel verification of DNS record.

Parameters:

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

emailServiceName - The name of the EmailService resource.

domainName - The name of the Domains resource.

parameters - Type of verification to be canceled.

context - The context to associate with this operation.

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

DomainResource getById(String id)

Get the Domains resource and its properties.

Parameters:

id - the resource ID.

Returns:

the Domains resource and its properties 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.

getByIdWithResponse

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

Get the Domains resource and its properties.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the Domains resource and its properties 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.

deleteById

void deleteById(String id)

Operation to delete a Domains resource.

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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Operation to delete a Domains resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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

DomainResource.DefinitionStages.Blank define(String name)

Begins definition for a new DomainResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DomainResource definition.