Fix: Add missing updates to the doc files

d365collaborative · Mar 2, 2024 · 9b3a83b · 9b3a83b
1 parent 7e55a8d
commit 9b3a83b
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 4 deletions.
diff --git a/d365bap.tools/functions/Compare-BapEnvironmentUser.ps1 b/d365bap.tools/functions/Compare-BapEnvironmentUser.ps1
@@ -75,7 +75,7 @@
         It will iterate over all of them, and validate against the Destination Environment.
         It will exclude those with ApplicationId filled.
         Will output all details into an Excel file, that will auto open on your machine.
-
+        
     .NOTES
         Author: Mötz Jensen (@Splaxi)
 #>

diff --git a/d365bap.tools/functions/Get-BapEnvironment.ps1 b/d365bap.tools/functions/Get-BapEnvironment.ps1
@@ -44,7 +44,7 @@
         
         This will query for ALL available environments.
         Will output all details into an Excel file, that will auto open on your machine.
-
+        
     .NOTES
         Author: Mötz Jensen (@Splaxi)
 #>

diff --git a/d365bap.tools/functions/Get-BapEnvironmentD365App.ps1 b/d365bap.tools/functions/Get-BapEnvironmentD365App.ps1
@@ -133,7 +133,7 @@
         This will query the environment for ALL available D365 Apps.
         It will compare available vs installed D365 Apps, and indicate whether an update is available of not.
         Will output all details into an Excel file, that will auto open on your machine.
-
+        
     .NOTES
         Author: Mötz Jensen (@Splaxi)
 #>

diff --git a/d365bap.tools/functions/Get-BapEnvironmentUser.ps1 b/d365bap.tools/functions/Get-BapEnvironmentUser.ps1
@@ -57,7 +57,7 @@
         
         This will fetch all oridinary users from the environment.
         Will output all details into an Excel file, that will auto open on your machine.
-
+        
     .NOTES
         Author: Mötz Jensen (@Splaxi)
 #>

diff --git a/docs/Compare-BapEnvironmentD365App.md b/docs/Compare-BapEnvironmentD365App.md
@@ -57,6 +57,15 @@ ea8d3b2f-ede2-46b4-900d-ed02c81c44fd AgentProductivityToolsAnchor   9.2.24021.10
 6ce2d70e-78bf-4ff6-85ed-1bd63d4ab444 ExportToDataLakeCoreAnchor     1.0.0.1             0.0.0.0             Azure Syna…
 7523d261-f1be-46e7-8e68-f3de16eeabbb DualWriteCoreAnchor            1.0.24022.4         1.0.24011.1         Dual-write…
 
+### EXAMPLE 3
+```
+Compare-BapEnvironmentD365App -SourceEnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -DestinationEnvironmentId 32c6b196-ef52-4c43-93cf-6ecba51e6aa1 -AsExcelOutput
+```
+
+This will get all installed D365 Apps from the Source Environment.
+It will iterate over all of them, and validate against the Destination Environment.
+Will output all details into an Excel file, that will auto open on your machine.
+
 ## PARAMETERS
 
 ### -SourceEnvironmentId

diff --git a/docs/Compare-BapEnvironmentUser.md b/docs/Compare-BapEnvironmentUser.md
@@ -73,6 +73,16 @@ d365-scm-operationdataservice… d365-scm-operationdataservice… 986556ed-a409-
 d365-scm-operationdataservice… d365-scm-operationdataservice… 14e80222-1878-455d-… 183ec023-9ccb-… Missing
 [email protected]                   Dustin Effect                                       01e37132-0a44-… Missing
 
+### EXAMPLE 4
+```
+Compare-BapEnvironmentD365App -SourceEnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -DestinationEnvironmentId 32c6b196-ef52-4c43-93cf-6ecba51e6aa1 -AsExcelOutput
+```
+
+This will get all system users from the Source Environment.
+It will iterate over all of them, and validate against the Destination Environment.
+It will exclude those with ApplicationId filled.
+Will output all details into an Excel file, that will auto open on your machine.
+
 ## PARAMETERS
 
 ### -SourceEnvironmentId

diff --git a/docs/Get-BapEnvironment.md b/docs/Get-BapEnvironment.md
@@ -50,6 +50,14 @@ PpacEnvId                            PpacEnvRegion   PpacEnvName          PpacEn
 ---------                            -------------   -----------          ---------- ------------------
 eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 europe          new-test             Sandbox    https://new-test.sandbox.operati…
 
+### EXAMPLE 3
+```
+Get-BapEnvironment -AsExcelOutput
+```
+
+This will query for ALL available environments.
+Will output all details into an Excel file, that will auto open on your machine.
+
 ## PARAMETERS
 
 ### -EnvironmentId

diff --git a/docs/Get-BapEnvironmentApplicationUser.md b/docs/Get-BapEnvironmentApplicationUser.md
@@ -38,6 +38,14 @@ b6e52ceb-f771-41ff-bd99-917523b28eaf AIBuilder_StructuredML_Prod_C… 3bafba76-6
 c76313fd-5c6f-4f1f-9869-c884fa7fe226 AppDeploymentOrchestration     d88a3535-ebf0-4b2b-ad23-90e686660a64 99aee001-009e…
 29494271-7e38-4433-8bf8-06d335299a17 AriaMdlExporter                8bf8862f-5036-42b0-a4f8-1b638db7896b 99aee001-009e…
 
+### EXAMPLE 2
+```
+Get-BapEnvironmentApplicationUser -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -AsExcelOutput
+```
+
+This will fetch all ApplicationUsers from the environment.
+Will output all details into an Excel file, that will auto open on your machine.
+
 ## PARAMETERS
 
 ### -EnvironmentId

diff --git a/docs/Get-BapEnvironmentD365App.md b/docs/Get-BapEnvironmentD365App.md
@@ -117,6 +117,15 @@ It will filter the output to only containing those who have an update available.
 It will persist the PackageIds for each D365 App, into an array.
 It will invoke the installation process using the Invoke-BapEnvironmentInstallD365App cmdlet.
 
+### EXAMPLE 7
+```
+Get-BapEnvironmentD365App -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -AsExcelOutput
+```
+
+This will query the environment for ALL available D365 Apps.
+It will compare available vs installed D365 Apps, and indicate whether an update is available of not.
+Will output all details into an Excel file, that will auto open on your machine.
+
 ## PARAMETERS
 
 ### -EnvironmentId

diff --git a/docs/Get-BapEnvironmentUser.md b/docs/Get-BapEnvironmentUser.md
@@ -56,6 +56,14 @@ INTEGRATION
 [email protected]                   Austin Baker                                        f85bcd69-ef72-45bd-a338-62670a8cef2a
 [email protected]  AIBuilderProd, #               0a143f2d-2320-4141-… c96f82b8-320f-4c5e-ac84-1831f4dc7d5f
 
+### EXAMPLE 3
+```
+Get-BapEnvironmentUser -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -AsExcelOutput
+```
+
+This will fetch all oridinary users from the environment.
+Will output all details into an Excel file, that will auto open on your machine.
+
 ## PARAMETERS
 
 ### -EnvironmentId
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,7 +44,7 @@ @@
             This will query for ALL available environments.
             Will output all details into an Excel file, that will auto open on your machine.
         .NOTES
             Author: Mötz Jensen (@Splaxi)
     #>
@@ Expand Down @@