Added SaaS BulkSeatChange clarifications

Celerium · Mar 2, 2024 · 947bf55 · 947bf55
1 parent 1fe55ca
commit 947bf55
Show file tree

Hide file tree

Showing 7 changed files with 905 additions and 899 deletions.
diff --git a/DattoAPI/Public/SaaS/Set-DattoBulkSeatChange.ps1 b/DattoAPI/Public/SaaS/Set-DattoBulkSeatChange.ps1
@@ -7,7 +7,7 @@ function Set-DattoBulkSeatChange {
         The Set-DattoBulkSeatChange cmdlet is used to bulk set SaaS
         Protection seat changes
 
-        Both "seatType" & "actionType" parameters are case-sensitive
+        Both 'seatType' & 'actionType' parameters are case-sensitive
 
     .PARAMETER saasCustomerId
         Defines the id of the Datto SaaS organization
@@ -29,7 +29,8 @@ function Set-DattoBulkSeatChange {
         Seat Types can be found by referencing the data returned from Get-DattoSeat
 
         Example:
-            'User', 'SharedMailbox', 'SharedDrive', 'Site', 'TeamSite', 'Team'
+            Office365: 'User', 'SharedMailbox', 'Site', 'TeamSite', 'Team'
+            Google:    'User', 'SharedDrive'
 
     .PARAMETER actionType
         Defines what action to take against the seat
@@ -62,7 +63,8 @@ function Set-DattoBulkSeatChange {
         Sets the Datto SaaS protection seats from the defined Google customer id
 
     .NOTES
-        N\A
+        This function does not work for legacy Google Seat Management 1.0 system.
+        Seat Management details can be found by referencing Datto's [documentation](https://saasprotection.datto.com/help/Google/Content/Managing_service_seats/01_Exploring_seat_management_features.htm).
 
     .LINK
         https://celerium.github.io/Datto-PowerShellWrapper/site/SaaS/Set-DattoBulkSeatChange.html

diff --git a/build/DattoAPI/2.3.0/DattoAPI.psm1 b/build/DattoAPI/2.3.0/DattoAPI.psm1
@@ -2581,7 +2581,7 @@ function Set-DattoBulkSeatChange {
         The Set-DattoBulkSeatChange cmdlet is used to bulk set SaaS
         Protection seat changes
 
-        Both "seatType" & "actionType" parameters are case-sensitive
+        Both 'seatType' & 'actionType' parameters are case-sensitive
 
     .PARAMETER saasCustomerId
         Defines the id of the Datto SaaS organization
@@ -2603,7 +2603,8 @@ function Set-DattoBulkSeatChange {
         Seat Types can be found by referencing the data returned from Get-DattoSeat
 
         Example:
-            'User', 'SharedMailbox', 'SharedDrive', 'Site', 'TeamSite', 'Team'
+            Office365: 'User', 'SharedMailbox', 'Site', 'TeamSite', 'Team'
+            Google:    'User', 'SharedDrive'
 
     .PARAMETER actionType
         Defines what action to take against the seat
@@ -2636,7 +2637,8 @@ function Set-DattoBulkSeatChange {
         Sets the Datto SaaS protection seats from the defined Google customer id
 
     .NOTES
-        N\A
+        This function does not work for legacy Google Seat Management 1.0 system.
+        Seat Management details can be found by referencing Datto's [documentation](https://saasprotection.datto.com/help/Google/Content/Managing_service_seats/01_Exploring_seat_management_features.htm).
 
     .LINK
         https://celerium.github.io/Datto-PowerShellWrapper/site/SaaS/Set-DattoBulkSeatChange.html
@@ -2693,4 +2695,4 @@ function Set-DattoBulkSeatChange {
 
     end {}
 }
-#EndRegion '.\Public\SaaS\Set-DattoBulkSeatChange.ps1' 122
+#EndRegion '.\Public\SaaS\Set-DattoBulkSeatChange.ps1' 124
diff --git a/build/DattoAPI_Built_Results.xml b/build/DattoAPI_Built_Results.xml
diff --git a/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.cab b/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.cab
diff --git a/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.zip b/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.zip
diff --git a/docs/en-US/DattoAPI-help.xml b/docs/en-US/DattoAPI-help.xml
@@ -4051,7 +4051,7 @@
     </command:details>
     <maml:description>
       <maml:para>The Set-DattoBulkSeatChange cmdlet is used to bulk set SaaS Protection seat changes</maml:para>
-      <maml:para>Both "seatType" &amp; "actionType" parameters are case-sensitive</maml:para>
+      <maml:para>Both 'seatType' &amp; 'actionType' parameters are case-sensitive</maml:para>
     </maml:description>
     <command:syntax>
       <command:syntaxItem>
@@ -4088,7 +4088,7 @@
             <maml:para>Defines the seat type to backup</maml:para>
             <maml:para>This is a case-sensitive value</maml:para>
             <maml:para>Seat Types can be found by referencing the data returned from Get-DattoSeat</maml:para>
-            <maml:para>Example:     'User', 'SharedMailbox', 'SharedDrive', 'Site', 'TeamSite', 'Team'</maml:para>
+            <maml:para>Example:     Office365: 'User', 'SharedMailbox', 'Site', 'TeamSite', 'Team'     Google:    'User', 'SharedDrive'</maml:para>
           </maml:description>
           <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
           <dev:type>
@@ -4183,7 +4183,7 @@
           <maml:para>Defines the seat type to backup</maml:para>
           <maml:para>This is a case-sensitive value</maml:para>
           <maml:para>Seat Types can be found by referencing the data returned from Get-DattoSeat</maml:para>
-          <maml:para>Example:     'User', 'SharedMailbox', 'SharedDrive', 'Site', 'TeamSite', 'Team'</maml:para>
+          <maml:para>Example:     Office365: 'User', 'SharedMailbox', 'Site', 'TeamSite', 'Team'     Google:    'User', 'SharedDrive'</maml:para>
         </maml:description>
         <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
         <dev:type>
@@ -4250,7 +4250,7 @@
     <command:returnValues />
     <maml:alertSet>
       <maml:alert>
-        <maml:para>N\A</maml:para>
+        <maml:para>This function does not work for legacy Google Seat Management 1.0 system. Seat Management details can be found by referencing Datto's \ documentation\ (https://saasprotection.datto.com/help/Google/Content/Managing_service_seats/01_Exploring_seat_management_features.htm).</maml:para>
       </maml:alert>
     </maml:alertSet>
     <command:examples>

diff --git a/docs/site/SaaS/Set-DattoBulkSeatChange.md b/docs/site/SaaS/Set-DattoBulkSeatChange.md
@@ -24,7 +24,7 @@ Set-DattoBulkSeatChange -saasCustomerId <String> -externalSubscriptionId <String
 The Set-DattoBulkSeatChange cmdlet is used to bulk set SaaS
 Protection seat changes
 
-Both "seatType" & "actionType" parameters are case-sensitive
+Both 'seatType' & 'actionType' parameters are case-sensitive
 
 ## EXAMPLES
 
@@ -88,7 +88,8 @@ This is a case-sensitive value
 Seat Types can be found by referencing the data returned from Get-DattoSeat
 
 Example:
-    'User', 'SharedMailbox', 'SharedDrive', 'Site', 'TeamSite', 'Team'
+    Office365: 'User', 'SharedMailbox', 'Site', 'TeamSite', 'Team'
+    Google:    'User', 'SharedDrive'
 
 ```yaml
 Type: String
@@ -185,7 +186,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## OUTPUTS
 
 ## NOTES
-N\A
+This function does not work for legacy Google Seat Management 1.0 system.
+Seat Management details can be found by referencing Datto's \[documentation\](https://saasprotection.datto.com/help/Google/Content/Managing_service_seats/01_Exploring_seat_management_features.htm).
 
 ## RELATED LINKS