Updated the set-teamviewermanageddevice function with additional description endpoint

Author: radu-cristea-15

Cmdlets/Public/Set-TeamViewerManagedDevice.ps1

@@ -23,7 +23,12 @@ function Set-TeamViewerManagedDevice {
         [ValidateScript( { $_ | Resolve-TeamViewerManagedGroupId } )]
         [Alias('ManagedGroupId')]
         [object]
-        $ManagedGroup
+        $ManagedGroup,
+
+        [Parameter(ParameterSetName = 'UpdateDescription')]
+        [Alias('DeviceDescription')]
+        [string]
+        $Description
     )
     Begin {
         $body = @{}
@@ -41,7 +46,17 @@ function Set-TeamViewerManagedDevice {
         if ($Policy -And $ManagedGroup) {
             $PSCmdlet.ThrowTerminatingError(
                 ('The combination of parameters -Policy and -ManagedGroup is not allowed.' | `
-                    ConvertTo-ErrorRecord -ErrorCategory InvalidArgument))
+                    ConvertToErrorRecord -ErrorCategory InvalidArgument))
+        }
+
+        if ($Description -And ($Policy -or $ManagedGroup)) {
+            $PSCmdlet.ThrowTerminatingError(
+                ('The parameter -Description cannot be combined with -Policy or -ManagedGroup.' |
+                ConvertTo-ErrorRecord -ErrorCategory InvalidArgument))
+        }
+
+        if ($Description) {
+            $body['deviceDescription'] = $Description
         }
 
         if ($body.Count -eq 0) {
@@ -54,6 +69,12 @@ function Set-TeamViewerManagedDevice {
         $deviceId = $Device | Resolve-TeamViewerManagedDeviceId
         $resourceUri = "$(Get-TeamViewerApiUri)/managed/devices/$deviceId"
 
+        switch ($PsCmdlet.ParameterSetName) {
+            'UpdateDescription' {
+                $resourceUri += '/description'
+            }
+        }
+
         if ($PSCmdlet.ShouldProcess($Device.ToString(), 'Change managed device entry')) {
             Invoke-TeamViewerRestMethod `
                 -ApiToken $ApiToken `

Tests/Public/Set-TeamViewerManagedDevice.Tests.ps1

@@ -45,6 +45,37 @@ Describe 'Set-TeamViewerManagedDevice' {
         $body.managedGroupId | Should -Be 'e579cfeb-0b29-4d91-9e81-2d9507f53ff8'
     }
 
+    It 'Should update the managed device description' {
+        Set-TeamViewerManagedDevice -ApiToken $testApiToken -Device $testDeviceId -Description 'Test description'
+        $mockArgs.Body | Should -Not -BeNullOrEmpty
+
+        $body = [System.Text.Encoding]::UTF8.GetString($mockArgs.Body) | ConvertFrom-Json
+        $body.deviceDescription | Should -Be 'Test description'
+
+        Assert-MockCalled Invoke-TeamViewerRestMethod -Times 1 -Scope It -ParameterFilter {
+            $ApiToken -eq $testApiToken -And `
+                $Uri -eq "//unit.test/managed/devices/$testDeviceId/description" -And `
+                $Method -eq 'Put'
+        }
+    }
+
+    It 'Should not allow description together with policy' {
+        { Set-TeamViewerManagedDevice `
+                -ApiToken $testApiToken `
+                -Device $testDeviceId `
+                -Description 'Test description' `
+                -Policy '2871c013-3040-4969-9ba4-ce970f4375e8' } | Should -Throw
+    }
+
+    It 'Should not allow description together with managed group' {
+        { Set-TeamViewerManagedDevice `
+                -ApiToken $testApiToken `
+                -Device $testDeviceId `
+                -Description 'Test description' `
+                -ManagedGroup 'e579cfeb-0b29-4d91-9e81-2d9507f53ff8' } | Should -Throw
+    }
+
+
     It 'Should not be possible to inherit and set a policy at the same time' {
         { Set-TeamViewerManagedDevice `
                 -ApiToken $testApiToken `