'Update comment based help and tests

This pull request was automatically created by the d365fo.tools-Generate-Text action'
FH-Inway · Jan 23, 2024 · 2983338 · 2983338
1 parent 437fc4b
commit 2983338
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 11 deletions.
diff --git a/d365fo.tools/functions/get-d365lcsenvironmentrsatcertificate.ps1 b/d365fo.tools/functions/get-d365lcsenvironmentrsatcertificate.ps1
@@ -86,10 +86,10 @@
         
     .EXAMPLE
         PS C:\> Get-D365LcsEnvironmentRsatCertificate -ProjectId "123456789" -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" | Import-D365RsatSelfServiceCertificates
-
+        
         This will download the active rsat certificate file for the environment from the LCS project.
         The resulting files are then imported into the certificate store on the local machine.
-
+        
     .NOTES
         Author: Mötz Jensen (@Splaxi)
 #>

diff --git a/d365fo.tools/tests/functions/Import-D365RsatSelfServiceCertificates.Tests.ps1 b/d365fo.tools/tests/functions/Import-D365RsatSelfServiceCertificates.Tests.ps1
@@ -21,7 +21,7 @@
 			$parameter.ParameterSets['__AllParameterSets'].IsMandatory | Should -Be $True
 			$parameter.ParameterSets['__AllParameterSets'].Position | Should -Be 0
 			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipeline | Should -Be $False
-			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $True
 			$parameter.ParameterSets['__AllParameterSets'].ValueFromRemainingArguments | Should -Be $False
 		}
 		It 'Should have the expected parameter Password' {
@@ -34,7 +34,7 @@
 			$parameter.ParameterSets['__AllParameterSets'].IsMandatory | Should -Be $True
 			$parameter.ParameterSets['__AllParameterSets'].Position | Should -Be 1
 			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipeline | Should -Be $False
-			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $False
+			$parameter.ParameterSets['__AllParameterSets'].ValueFromPipelineByPropertyName | Should -Be $True
 			$parameter.ParameterSets['__AllParameterSets'].ValueFromRemainingArguments | Should -Be $False
 		}
 	}

diff --git a/docs/Get-D365LcsEnvironmentRsatCertificate.md b/docs/Get-D365LcsEnvironmentRsatCertificate.md
@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-D365LcsEnvironmentRsatCertificate
 
 ## SYNOPSIS
-Get LCS environment meta data from within a project
+Get LCS environment rsat certificate from within a project
 
 ## SYNTAX
 
@@ -19,9 +19,7 @@ Get-D365LcsEnvironmentRsatCertificate [[-ProjectId] <Int32>] [[-BearerToken] <St
 ```
 
 ## DESCRIPTION
-Get all meta data details for environments from within a LCS project
-
-It supports listing all environments, but also supports single / specific environments by searching based on EnvironmentId or EnvironmentName
+Download and persist the active rsat certificate from environments from within a LCS project
 
 ## EXAMPLES
 
@@ -42,6 +40,14 @@ PfxFile  : C:\temp\d365fo.tools\RsatCert\RSATCertificate_ABC-UAT_20240101-012030
 FileName : RSATCertificate_ABC-UAT_20240101-012030.zip
 Password : 9zbPiLMTk676mkq5FvqQ
 
+### EXAMPLE 2
+```
+Get-D365LcsEnvironmentRsatCertificate -ProjectId "123456789" -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" | Import-D365RsatSelfServiceCertificates
+```
+
+This will download the active rsat certificate file for the environment from the LCS project.
+The resulting files are then imported into the certificate store on the local machine.
+
 ## PARAMETERS
 
 ### -ProjectId

diff --git a/docs/Import-D365RsatSelfServiceCertificates.md b/docs/Import-D365RsatSelfServiceCertificates.md
@@ -29,7 +29,7 @@ The zip file needs to be unblocked and then extracted into a folder, with only t
 Import-D365RsatSelfServiceCertificates -Path "C:\Temp\UAT" -Password "123456789"
 ```
 
-This will import the .cer and .pxf files into the correct stored, bases on the files located in "C:\Temp\UAT".
+This will import the .cer and .pxf files into the correct store, bases on the files located in "C:\Temp\UAT".
 After import it will display the thumbprint for both certificates.
 
 Sample output:
@@ -51,7 +51,7 @@ Aliases:
 Required: True
 Position: 1
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
@@ -68,7 +68,7 @@ Aliases:
 Required: True
 Position: 2
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```