Managed Office Communications Server::RemoveSharedPool

This procedure removes an Office Communications Server pool from the shared pools list. Removing a pool would update the pools status to "Unavailable", but would not delete it from the list of pools

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.

Preconditions

The Pool has been added in Shared Pools list.

Business Rules

Calling this procedure multiple times should succeed.

Post-conditions

The pool status should be set to "Unavailable".

Sequence Narrative

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

2. The Managed Office Communications Server namespace calls private procedure SetSharedPoolProperties_ to set poolStatus to "Unavailable".

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="RemoveSharedPool" 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::DeleteSharedPool
Managed Office Communications Server::GetSharedPools
Managed Office Communications Server::SetSharedPoolProperties