Domains interface

Package:

@azure/arm-communication

Interface representing a Domains.

Methods

beginCancelVerification(string, string, string, VerificationParameter, DomainsCancelVerificationOptionalParams)	Cancel verification of DNS record.
beginCancelVerificationAndWait(string, string, string, VerificationParameter, DomainsCancelVerificationOptionalParams)	Cancel verification of DNS record.
beginCreateOrUpdate(string, string, string, DomainResource, DomainsCreateOrUpdateOptionalParams)	Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
beginCreateOrUpdateAndWait(string, string, string, DomainResource, DomainsCreateOrUpdateOptionalParams)	Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
beginDelete(string, string, string, DomainsDeleteOptionalParams)	Operation to delete a Domains resource.
beginDeleteAndWait(string, string, string, DomainsDeleteOptionalParams)	Operation to delete a Domains resource.
beginInitiateVerification(string, string, string, VerificationParameter, DomainsInitiateVerificationOptionalParams)	Initiate verification of DNS record.
beginInitiateVerificationAndWait(string, string, string, VerificationParameter, DomainsInitiateVerificationOptionalParams)	Initiate verification of DNS record.
beginUpdate(string, string, string, UpdateDomainRequestParameters, DomainsUpdateOptionalParams)	Operation to update an existing Domains resource.
beginUpdateAndWait(string, string, string, UpdateDomainRequestParameters, DomainsUpdateOptionalParams)	Operation to update an existing Domains resource.
get(string, string, string, DomainsGetOptionalParams)	Get the Domains resource and its properties.
listByEmailServiceResource(string, string, DomainsListByEmailServiceResourceOptionalParams)	Handles requests to list all Domains resources under the parent EmailServices resource.

Method Details

beginCancelVerification(string, string, string, VerificationParameter, DomainsCancelVerificationOptionalParams)

Cancel verification of DNS record.

function beginCancelVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsCancelVerificationOptionalParams): Promise<SimplePollerLike<OperationState<DomainsCancelVerificationHeaders>, DomainsCancelVerificationHeaders>>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

VerificationParameter

Type of verification to be canceled.

options

DomainsCancelVerificationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DomainsCancelVerificationHeaders>, DomainsCancelVerificationHeaders>>

beginCancelVerificationAndWait(string, string, string, VerificationParameter, DomainsCancelVerificationOptionalParams)

Cancel verification of DNS record.

function beginCancelVerificationAndWait(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsCancelVerificationOptionalParams): Promise<DomainsCancelVerificationHeaders>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

VerificationParameter

Type of verification to be canceled.

options

DomainsCancelVerificationOptionalParams

The options parameters.

Returns

Promise<DomainsCancelVerificationHeaders>

beginCreateOrUpdate(string, string, string, DomainResource, DomainsCreateOrUpdateOptionalParams)

Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.

function beginCreateOrUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: DomainResource, options?: DomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DomainResource>, DomainResource>>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

DomainResource

Parameters for the create or update operation

options

DomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DomainResource>, DomainResource>>

beginCreateOrUpdateAndWait(string, string, string, DomainResource, DomainsCreateOrUpdateOptionalParams)

Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.

function beginCreateOrUpdateAndWait(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: DomainResource, options?: DomainsCreateOrUpdateOptionalParams): Promise<DomainResource>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

DomainResource

Parameters for the create or update operation

options

DomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DomainResource>

beginDelete(string, string, string, DomainsDeleteOptionalParams)

Operation to delete a Domains resource.

function beginDelete(resourceGroupName: string, emailServiceName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

options

DomainsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, DomainsDeleteOptionalParams)

Operation to delete a Domains resource.

function beginDeleteAndWait(resourceGroupName: string, emailServiceName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

options

DomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginInitiateVerification(string, string, string, VerificationParameter, DomainsInitiateVerificationOptionalParams)

Initiate verification of DNS record.

function beginInitiateVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsInitiateVerificationOptionalParams): Promise<SimplePollerLike<OperationState<DomainsInitiateVerificationHeaders>, DomainsInitiateVerificationHeaders>>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

VerificationParameter

Type of verification to be initiated.

options

DomainsInitiateVerificationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DomainsInitiateVerificationHeaders>, DomainsInitiateVerificationHeaders>>

beginInitiateVerificationAndWait(string, string, string, VerificationParameter, DomainsInitiateVerificationOptionalParams)

Initiate verification of DNS record.

function beginInitiateVerificationAndWait(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsInitiateVerificationOptionalParams): Promise<DomainsInitiateVerificationHeaders>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

VerificationParameter

Type of verification to be initiated.

options

DomainsInitiateVerificationOptionalParams

The options parameters.

Returns

Promise<DomainsInitiateVerificationHeaders>

beginUpdate(string, string, string, UpdateDomainRequestParameters, DomainsUpdateOptionalParams)

Operation to update an existing Domains resource.

function beginUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: UpdateDomainRequestParameters, options?: DomainsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DomainResource>, DomainResource>>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

UpdateDomainRequestParameters

Parameters for the update operation

options

DomainsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DomainResource>, DomainResource>>

beginUpdateAndWait(string, string, string, UpdateDomainRequestParameters, DomainsUpdateOptionalParams)

Operation to update an existing Domains resource.

function beginUpdateAndWait(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: UpdateDomainRequestParameters, options?: DomainsUpdateOptionalParams): Promise<DomainResource>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

parameters

UpdateDomainRequestParameters

Parameters for the update operation

options

DomainsUpdateOptionalParams

The options parameters.

Returns

Promise<DomainResource>

get(string, string, string, DomainsGetOptionalParams)

Get the Domains resource and its properties.

function get(resourceGroupName: string, emailServiceName: string, domainName: string, options?: DomainsGetOptionalParams): Promise<DomainResource>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

options

DomainsGetOptionalParams

The options parameters.

Returns

Promise<DomainResource>

listByEmailServiceResource(string, string, DomainsListByEmailServiceResourceOptionalParams)

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

function listByEmailServiceResource(resourceGroupName: string, emailServiceName: string, options?: DomainsListByEmailServiceResourceOptionalParams): PagedAsyncIterableIterator<DomainResource, DomainResource[], PageSettings>

Parameters

resourceGroupName

string

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

emailServiceName

string

The name of the EmailService resource.

options

DomainsListByEmailServiceResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DomainResource, DomainResource[], PageSettings>