Managed Office Communications Server::DeleteSharedPool

This procedure deletes a pool from the list of shared pools. This is actually deleting the entry from Active Directory, while RemoveSharedPool only sets pool status to "Unavailable".

Arguments

Remarks

Security

The caller must be at least a member of role: Domain Administrator

Permission Check

This procedure will perform a test for Domain Administrator.

Business Rules

Calling this procedure multiple times should succeed.

Post-conditions

The pool entry should be deleted from the Shared Pools list if it exists. If it doesn't exist, this procedure will do nothing.

Sequence Narrative

1. Actor submits DeleteSharedPool request to the Managed Office Communications Server namespace.

2. Try: The Managed Office Communications Server Namespace calls the Managed Helpers::DeleteServicePointer_ to delete the Pool from the Shared Pools list.

3. Catch: If an error (0x80004005) occurs in the above step and it is because the Service Pointer does not exist, the error is suppressed using Managed Active Directory::RethrowError_.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The fully qualified domain name (FQDN) of the pool being added to the list of shared pools.--> 
    <poolFQDN>pool01.fabrikam.com</poolFQDN> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="DeleteSharedPool" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="poolFQDN" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
  <data /> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

• Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Office Communications Server::AddSharedPool
Managed Office Communications Server::RemoveSharedPool
Managed Office Communications Server::GetSharedPools
Managed Office Communications Server::SetSharedPoolProperties