| external help file | TeamViewerPS-help.xml |
|---|---|
| Module Name | TeamViewerPS |
| online version | https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerContact.md |
| schema | 2.0.0 |
Delete a contact from the Computers & Contacts list.
Remove-TeamViewerContact [-ApiToken] <SecureString> [-Contact] <Object> [-WhatIf] [-Confirm]
[<CommonParameters>]Deletes a contact from the Computers & Contacts list of the account associated to the API access token.
PS /> Remove-TeamViewerContact -Contact 'c1234'The TeamViewer API access token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseObject that can be used to identify the contact. This can either be the contact ID or a contact object that has been received using other module functions.
Type: Object
Parameter Sets: (All)
Aliases: Id, ContactId
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.