DomainsImpl | @azure/arm-communication

Class containing Domains operations.

Hierarchy

DomainsImpl

Implements

Domains

Index

Constructors

constructor

Methods

Constructors

constructor

new DomainsImpl(client: CommunicationServiceManagementClient): DomainsImpl

- Defined in operations/domains.ts:41
Initialize a new instance of the class Domains class.

Parameters
- client: CommunicationServiceManagementClient
  
  Reference to the service client
Returns DomainsImpl

Methods

beginCancelVerification

beginCancelVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsCancelVerificationOptionalParams): Promise<PollerLike<PollOperationState<DomainsCancelVerificationResponse>, DomainsCancelVerificationResponse>>

Implementation of Domains.beginCancelVerification
- Defined in operations/domains.ts:547
Cancel verification of DNS record.

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.
- Optional options: DomainsCancelVerificationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainsCancelVerificationResponse>, DomainsCancelVerificationResponse>>

beginCancelVerificationAndWait

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

Implementation of Domains.beginCancelVerificationAndWait
- Defined in operations/domains.ts:620
Cancel verification of DNS record.

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.
- Optional options: DomainsCancelVerificationOptionalParams
  
  The options parameters.
Returns Promise<DomainsCancelVerificationResponse>

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: DomainResource, options?: DomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>

Implementation of Domains.beginCreateOrUpdate
- Defined in operations/domains.ts:150
Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.

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
- Optional options: DomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of Domains.beginCreateOrUpdateAndWait
- Defined in operations/domains.ts:224
Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.

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
- Optional options: DomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DomainsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, emailServiceName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Domains.beginDelete
- Defined in operations/domains.ts:248
Operation to delete a Domains resource.

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.
- Optional options: DomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of Domains.beginDeleteAndWait
- Defined in operations/domains.ts:314
Operation to delete a Domains resource.

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.
- Optional options: DomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginInitiateVerification

beginInitiateVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsInitiateVerificationOptionalParams): Promise<PollerLike<PollOperationState<DomainsInitiateVerificationResponse>, DomainsInitiateVerificationResponse>>

Implementation of Domains.beginInitiateVerification
- Defined in operations/domains.ts:449
Initiate verification of DNS record.

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.
- Optional options: DomainsInitiateVerificationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainsInitiateVerificationResponse>, DomainsInitiateVerificationResponse>>

beginInitiateVerificationAndWait

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

Implementation of Domains.beginInitiateVerificationAndWait
- Defined in operations/domains.ts:522
Initiate verification of DNS record.

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.
- Optional options: DomainsInitiateVerificationOptionalParams
  
  The options parameters.
Returns Promise<DomainsInitiateVerificationResponse>

beginUpdate

beginUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: UpdateDomainRequestParameters, options?: DomainsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainsUpdateResponse>, DomainsUpdateResponse>>

Implementation of Domains.beginUpdate
- Defined in operations/domains.ts:337
Operation to update an existing Domains resource.

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
- Optional options: DomainsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainsUpdateResponse>, DomainsUpdateResponse>>

beginUpdateAndWait

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

Implementation of Domains.beginUpdateAndWait
- Defined in operations/domains.ts:407
Operation to update an existing Domains resource.

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
- Optional options: DomainsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DomainsUpdateResponse>

get

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

Implementation of Domains.get
- Defined in operations/domains.ts:129
Get the Domains resource and its properties.

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.
- Optional options: DomainsGetOptionalParams
  
  The options parameters.
Returns Promise<DomainsGetResponse>

listByEmailServiceResource

listByEmailServiceResource(resourceGroupName: string, emailServiceName: string, options?: DomainsListByEmailServiceResourceOptionalParams): PagedAsyncIterableIterator<DomainResource>

Implementation of Domains.listByEmailServiceResource
- Defined in operations/domains.ts:57
Handles requests to list all Domains resources under the parent EmailServices resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- emailServiceName: string
  
  The name of the EmailService resource.
- Optional options: DomainsListByEmailServiceResourceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DomainResource>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CommunicationServiceManagementClient

Returns DomainsImpl

Methods

beginCancelVerification

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: VerificationParameter

Optional options: DomainsCancelVerificationOptionalParams

Returns Promise<PollerLike<PollOperationState<DomainsCancelVerificationResponse>, DomainsCancelVerificationResponse>>

beginCancelVerificationAndWait

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: VerificationParameter

Optional options: DomainsCancelVerificationOptionalParams

Returns Promise<DomainsCancelVerificationResponse>

beginCreateOrUpdate

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: DomainResource

Optional options: DomainsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: DomainResource

Optional options: DomainsCreateOrUpdateOptionalParams

Returns Promise<DomainsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

Optional options: DomainsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

Optional options: DomainsDeleteOptionalParams

Returns Promise<void>

beginInitiateVerification

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: VerificationParameter

Optional options: DomainsInitiateVerificationOptionalParams

Returns Promise<PollerLike<PollOperationState<DomainsInitiateVerificationResponse>, DomainsInitiateVerificationResponse>>

beginInitiateVerificationAndWait

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: VerificationParameter

Optional options: DomainsInitiateVerificationOptionalParams

Returns Promise<DomainsInitiateVerificationResponse>

beginUpdate

Parameters

resourceGroupName: string

emailServiceName: string

domainName: string

parameters: UpdateDomainRequestParameters

Optional options: DomainsUpdateOptionalParams