Topic Last Modified: 2010-10-01
Removes a trusted application endpoint.
Syntax
Remove-CsTrustedApplicationEndpoint -Identity
<UserIdParameter> [-Confirm [<SwitchParameter>]]
[-WhatIf [<SwitchParameter>]]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
UserIdParameter |
The Identity (the distinguished name of the contact), SIP address, or display name of the application endpoint to be removed. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Detailed Description
A trusted application endpoint is an Active Directory contact object that enables routing of calls to a trusted application. This cmdlet removes an existing endpoint contact object from Active Directory Domain Services (AD DS).
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsTrustedApplicationEndpoint cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsTrustedApplicationEndpoint"}
Input Types
Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. Accepts pipelined input of trusted application endpoint objects.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.
Example
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Remove-CsTrustedApplicationEndpoint -Identity "Endpoint 1" |
This example removes the endpoint contact with the Identity (in this case the display name) Endpoint 1. Because identities must be unique, this command will remove, at most, one endpoint.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Get-CsTrustedApplicationEndpoint -ApplicationId tapp2 | Remove-CsTrustedApplicationEndpoint |
This example removes all trusted application endpoints associated with the application tapp2. This is accomplished by first calling Get-CsTrustedApplicationEndpoint and passing the ID tapp2 to the ApplicationId parameter. This will return a collection of endpoints that are associated with the tapp2 trusted application. This collection is then piped to the Remove-CsTrustedApplicationEndpoint cmdlet, which removes each endpoint in the collection. Keep in mind that this call to Get-CsTrustedApplicationEndpoint could retrieve endpoints with the application ID tapp2 from multiple pools, which would result in this command removing trusted application endpoints from multiple pools.