Updated ShouldProcess output

Updated ShouldProcess output and made easier to read in the code. Also updated some examples given for Set-DattoBulkSeatChange and docs
Celerium · Jan 19, 2024 · 12f5790 · 12f5790
1 parent 44c6f9d
commit 12f5790
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/DattoAPI/Public/SaaS/Set-DattoBulkSeatChange.ps1 b/DattoAPI/Public/SaaS/Set-DattoBulkSeatChange.ps1
@@ -13,12 +13,13 @@ function Set-DattoBulkSeatChange {
         Defines the external Subscription ID of the SaaS Protection Organization used to set SaaS bulk seat changes
 
     .EXAMPLE
-        Set-DattoBulkSeatChange -saasCustomerId "12345678" -externalSubscriptionId 'Classic:Office365:123456' -seatType "User" -remoteId "ab23-bdf234-1234-asdf" -actionType "License"
+        Set-DattoBulkSeatChange -saasCustomerId "123456" -externalSubscriptionId 'Classic:Office365:567890' -seatType "User" -remoteId "ab23-bdf234-1234-asdf","cd45-cfe567-5678-qwer" -actionType "License"
 
         Sets the Datto SaaS protection seats from the defined Office365 customer id
 
     .EXAMPLE
-        Set-DattoBulkSeatChange -saasCustomerId "12345678" -externalSubscriptionId 'Classic:GoogleApps:123456' -seatType "SharedDrive" -remoteId "ab23-bdf234-1234-asdf","cd45-cfe567-5678-qwer" -actionType "Pause"
+        Set-DattoBulkSeatChange -saasCustomerId "123456" -externalSubscriptionId 'Classic:GoogleApps:567890' -seatType "User" -remoteId "132347796423154833164","165482361285249794358" -actionType "License"
+        Set-DattoBulkSeatChange -saasCustomerId "123456" -externalSubscriptionId 'Classic:GoogleApps:567890' -seatType "SharedDrive" -remoteId "0A7gHPLvNmJ9RUk3PQI","0B5rZXCtUyP4SUk2PVA" -actionType "Pause"
 
         Sets the Datto SaaS protection seats from the defined Google customer id
 
@@ -60,7 +61,7 @@ function Set-DattoBulkSeatChange {
         [ValidateNotNullOrEmpty()]
         [string]$actionType,
 
-        # Either like 'Classic:Office365:123456', or 'Classic:GoogleApps:123456'
+        # Either like 'Classic:Office365:567890', or 'Classic:GoogleApps:567890'
         [Parameter(
             Mandatory = $true,
             ValueFromPipeline = $true,
@@ -85,7 +86,10 @@ function Set-DattoBulkSeatChange {
 
     process {
 
-        if ($PSCmdlet.ShouldProcess("saasCustomerId: $saasCustomerId, externalSubscriptionId: $externalSubscriptionId, $remoteId", "$actionType $seatType")) {
+        $target = "saasCustomerId: $saasCustomerId, externalSubscriptionId: $externalSubscriptionId, $remoteId"
+        $operation = "Set-DattoBulkSeatChange - $actionType $seatType"
+
+        if ($PSCmdlet.ShouldProcess($target, $operation)) {
             Write-Verbose "Running the [ $($PSCmdlet.ParameterSetName) ] parameterSet"
             Set-Variable -Name 'Datto_bulkSeatParameters' -Value $PSBoundParameters -Scope Global -Force
 

diff --git a/docs/site/SaaS/Set-DattoBulkSeatChange.md b/docs/site/SaaS/Set-DattoBulkSeatChange.md
@@ -26,14 +26,18 @@ The `Set-DattoBulkSeatChange` cmdlet sets the Datto SaaS Protection bulk seat ch
 
 ### EXAMPLE 1
 ```powershell
-Set-DattoBulkSeatChange -saasCustomerId "12345678" -externalSubscriptionId 'Classic:Office365:123456' -seatType "User" -remoteId "ab23-bdf234-1234-asdf" -actionType "License"
+Set-DattoBulkSeatChange -saasCustomerId "123456" -externalSubscriptionId 'Classic:Office365:567890' -seatType "User" -remoteId "ab23-bdf234-1234-asdf","cd45-cfe567-5678-qwer" -actionType "License"
 ```
 
 Sets the Datto SaaS protection seats from the defined Office365 customer id
 
 ### EXAMPLE 2
 ```powershell
-Set-DattoBulkSeatChange -saasCustomerId "12345678" -externalSubscriptionId 'Classic:GoogleApps:123456' -seatType "SharedDrive" -remoteId "ab23-bdf234-1234-asdf","cd45-cfe567-5678-qwer" -actionType "Pause"
+Set-DattoBulkSeatChange -saasCustomerId "123456" -externalSubscriptionId 'Classic:GoogleApps:567890' -seatType "User" -remoteId "132347796423154833164","165482361285249794358" -actionType "License"
+```
+
+```powershell
+Set-DattoBulkSeatChange -saasCustomerId "123456" -externalSubscriptionId 'Classic:GoogleApps:567890' -seatType "SharedDrive" -remoteId "0A7gHPLvNmJ9RUk3PQI","0B5rZXCtUyP4SUk2PVA" -actionType "Pause"
 ```
 
 Sets the Datto SaaS protection seats from the defined Google customer id