IDnsService.RemoveDomainsAsync Method

IDnsServiceRemoveDomainsAsync Method

This API is preliminary and subject to change.

Removes one or more domains from the DNS service.

Namespace: net.openstack.Providers.Rackspace
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

Task<DnsJob> RemoveDomainsAsync(
	IEnumerable<DomainId> domainIds,
	bool deleteSubdomains,
	AsyncCompletionOption completionOption,
	CancellationToken cancellationToken,
	IProgress<DnsJob> progress
)

Function RemoveDomainsAsync ( 
	domainIds As IEnumerable(Of DomainId),
	deleteSubdomains As Boolean,
	completionOption As AsyncCompletionOption,
	cancellationToken As CancellationToken,
	progress As IProgress(Of DnsJob)
) As Task(Of DnsJob)

Task<DnsJob^>^ RemoveDomainsAsync(
	IEnumerable<DomainId^>^ domainIds, 
	bool deleteSubdomains, 
	AsyncCompletionOption completionOption, 
	CancellationToken cancellationToken, 
	IProgress<DnsJob^>^ progress
)

abstract RemoveDomainsAsync : 
        domainIds : IEnumerable<DomainId> * 
        deleteSubdomains : bool * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<DnsJob> -> Task<DnsJob>

Parameters

domainIds: Type: System.Collections.GenericIEnumerableDomainId
A collection of IDs for the domains to remove. These are obtained from DnsDomain.Id.
deleteSubdomains: Type: SystemBoolean
to delete any subdomains associated with the specified domains; otherwise, to promote any subdomains to top-level domains.
completionOption: Type: net.openstack.CoreAsyncCompletionOption
Specifies when the Task representing the asynchronous server operation should be considered complete.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
progress: Type: SystemIProgressDnsJob
An optional callback object to receive progress notifications, if completionOption is RequestCompleted. If this is , no progress notifications are sent.

Return Value

Type: TaskDnsJob
A Task object representing the asynchronous operation. When the task completes successfully, the Result property will return a DnsJob object describing the asynchronous server operation. If completionOption is RequestCompleted, the job will additionally be in one of the following states.

Completed
Error: In this case the Error property provides additional information about the error which occurred during the asynchronous server operation.

Exceptions

Exception	Condition
ArgumentNullException	If domainIds is .
ArgumentException	If domainIds contains any values. -or- If completionOption is not a valid AsyncCompletionOption.
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If domainIds is .

ArgumentException

If domainIds contains any values.

-or-

If completionOption is not a valid AsyncCompletionOption.

WebException

If the REST request does not return successfully.

Version Information