Merge pull request MicrosoftDocs#3356 from Spoonsk/3328-hgsclient-module

Quality: PowerShell Summit MicrosoftDocsGH-3328

Author: sdwheeler

docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md

@@ -11,54 +11,61 @@ title: ConvertTo-HgsKeyProtector
 # ConvertTo-HgsKeyProtector
 
 ## SYNOPSIS
+
 Converts a key protector into a Host Guardian Service key protector.
 
 ## SYNTAX
 
 ```
-ConvertTo-HgsKeyProtector [-Bytes] <Byte[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
- [<CommonParameters>]
+ConvertTo-HgsKeyProtector [-Bytes] <Byte[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
+[-AsJob] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The **ConvertTo-HgsKeyProtector** cmdlet converts an existing key protector into a Host Guardian Service key protector object.
-Specify the existing key protector as a byte array.
-You might use this cmdlet to import a key protector from a virtual machine configuration file.
+
+The `ConvertTo-HgsKeyProtector` cmdlet converts an existing key protector into a Host Guardian
+Service key protector object. Specify the existing key protector as a byte array. You might use
+this cmdlet to import a key protector from a virtual machine configuration file.
 
 ## EXAMPLES
 
 ### Example 1: Convert a key protector
-```
-PS C:\> $VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17" 
-PS C:\> $VirtualMachineKeyProtector = $VirtualTPM.KeyProtector 
-PS C:\> $KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector
+
+```powershell
+$VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17"
+$VirtualMachineKeyProtector = $VirtualTPM.KeyProtector
+$KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector
 ```
 
-The first command gets the Trusted Platform Module (TPM) object for the virtual machine named Shielded Virtual Machine 17.
-The command stores the object in the **$VirtualTPM** variable.
+The first command gets the Trusted Platform Module (TPM) object for the virtual machine named
+Shielded Virtual Machine 17. The command stores the object in the `$VirtualTPM` variable.
 
-The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in the **$VirtualMachineKeyProtector** variable.
+The second command stores the **KeyProtector** property of the object stored in `$VirtualTPM` in
+the `$VirtualMachineKeyProtector` variable.
 
-The final command creates a Host Guardian Service key protector object from the byte array representation stored in **$VirtualMachineKeyProtector**.
-The command stores the new key protector in the **$KeyProtector** variable.
+The final command creates a Host Guardian Service key protector object from the byte array
+representation stored in `$VirtualMachineKeyProtector`. The command stores the new key protector
+in the `$KeyProtector` variable.
 
 ## PARAMETERS
 
 ### -AsJob
-Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. 
 
-The cmdlet immediately returns an object that represents the job and then displays the command prompt. 
-You can continue to work in the session while the job completes. 
-To manage the job, use the `*-Job` cmdlets. 
-To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. 
+Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
+complete.
 
-For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
+The cmdlet immediately returns an object that represents the job and then displays the command
+prompt. You can continue to work in the session while the job completes. To manage the job, use the
+`*-Job` cmdlets. To get the job results, use the
+[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
 
+For more information about Windows PowerShell background jobs, see
+[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
 
 ```yaml
-Type: SwitchParameter
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -68,13 +75,14 @@ Accept wildcard characters: False
 ```
 
 ### -Bytes
-Specifies the existing key protector as a byte array.
-This cmdlet generates a key protector object from the existing key protector that this parameter specifies.
+
+Specifies the existing key protector as a byte array. This cmdlet generates a key protector object
+from the existing key protector that this parameter specifies.
 
 ```yaml
-Type: Byte[]
+Type: System.Byte[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -84,12 +92,14 @@ Accept wildcard characters: False
 ```
 
 ### -CimSession
-Runs the cmdlet in a remote session or on a remote computer.
-Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
-The default is the current session on the local computer.
+
+Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
+object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
+or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
+current session on the local computer.
 
 ```yaml
-Type: CimSession[]
+Type: Microsoft.Management.Infrastructure.CimSession[]
 Parameter Sets: (All)
 Aliases: Session
 
@@ -101,14 +111,17 @@ Accept wildcard characters: False
 ```
 
 ### -ThrottleLimit
-Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
-If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
-The throttle limit applies only to the current cmdlet, not to the session or to the computer.
+
+Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
+this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
+optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
+computer. The throttle limit applies only to the current cmdlet, not to the session or to the
+computer.
 
 ```yaml
-Type: Int32
+Type: System.Int32
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -118,21 +131,26 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
 ## OUTPUTS
 
 ### Microsoft.Management.Infrastructure.CimInstance#MSFT_HgsKeyProtector
+
 This cmdlet returns a key protector.
 
-The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
-The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
+The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
+Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
+namespace and class name for the underlying WMI object.
 
 ## NOTES
 
 ## RELATED LINKS
 
 [New-HgsKeyProtector](./New-HgsKeyProtector.md)
-

docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md

@@ -20,26 +20,32 @@ Export-HgsGuardian [-InputObject] <CimInstance> [-Path] <String> [<CommonParamet
 ```
 
 ## DESCRIPTION
-The **Export-HgsGuardian** cmdlet exports a guardian that contains public keys to an .xml file.
+
+The `Export-HgsGuardian` cmdlet exports a guardian that contains public keys to an `.xml` file.
 
 ## EXAMPLES
 
 ### Example 1: Export a guardian
-```
-PS C:\> Get-HgsGuardian -Name "Guardian11" | Export-HGsGuardian -Path "C:\LocalHGSFiles\Guardian11.xml"
+
+```powershell
+Get-HgsGuardian -Name 'Guardian11' |
+    Export-HGsGuardian -Path 'C:\LocalHGSFiles\Guardian11.xml'
 ```
 
-This command uses the **Get-HgsGuardian** cmdlet to get the guardian named Guardian11, and then passes the object to the current cmdlet by using the pipeline operator.
-That cmdlet exports the guardian to the specified file.
+This command uses the `Get-HgsGuardian` cmdlet to get the guardian named `Guardian11`, and then
+passes the object to the current cmdlet by using the pipeline operator. That cmdlet exports the
+guardian to the specified file.
 
 ## PARAMETERS
 
 ### -InputObject
-Specifies the input to this cmdlet. 
+
+Specifies the input to this cmdlet.
+
 You can use this parameter, or you can pipe the input to this cmdlet.
 
 ```yaml
-Type: CimInstance
+Type: Microsoft.Management.Infrastructure.CimInstance
 Parameter Sets: (All)
 Aliases: Guardian
 
@@ -51,10 +57,11 @@ Accept wildcard characters: False
 ```
 
 ### -Path
+
 Specifies the path to the file to write an XML representation of the guardian.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
 Aliases: FilePath
 
@@ -66,7 +73,10 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
@@ -83,4 +93,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 [New-HgsGuardian](./New-HgsGuardian.md)
 
 [Remove-HgsGuardian](./Remove-HgsGuardian.md)
-

docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md

@@ -26,31 +26,35 @@ Get-HgsAttestationBaselinePolicy [-Console] [-SkipValidation] [<CommonParameters
 ```
 
 ## DESCRIPTION
-The **Get-HgsAttestationBaselinePolicy** cmdlet generates an attestation baseline policy.
-You can use the policy to configure the attestation service.
 
-This cmdlet gets a byte array that represents the attestation baseline policy from the raw data of the last full boot from the Trusted Computing Group log of the Trusted Platform Module (TPM).
+The `Get-HgsAttestationBaselinePolicy` cmdlet generates an attestation baseline policy. You can use
+the policy to configure the attestation service.
+
+This cmdlet gets a byte array that represents the attestation baseline policy from the raw data of
+the last full boot from the Trusted Computing Group log of the Trusted Platform Module (TPM).
 
 Be sure to run this cmdlet on a host that is known to have good configuration.
 
 ## EXAMPLES
 
 ### Example 1: Generate a baseline policy
-```
-PS C:\> Get-HgsAttestationBaselinePolicy -Path "C:\Logs\AttestationBaselinePolicy001" -Force
+
+```powershell
+Get-HgsAttestationBaselinePolicy -Path 'C:\Logs\AttestationBaselinePolicy001' -Force
 ```
 
-This command generates a byte array that represents the baseline policy in the file C:\Logs\AttestationBaselinePolicy001.
+This command generates a byte array that represents the baseline policy in the file `C:\Logs\AttestationBaselinePolicy001`.
 
 ## PARAMETERS
 
 ### -Console
+
 Indicates that this cmdlet operates in console mode.
 
 ```yaml
-Type: SwitchParameter
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: Console
-Aliases: 
+Aliases:
 
 Required: True
 Position: Named
@@ -60,12 +64,13 @@ Accept wildcard characters: False
 ```
 
 ### -Force
+
 Indicates that this cmdlet overwrites an existing file that the **Output** object specifies.
 
 ```yaml
-Type: SwitchParameter
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: File
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -75,11 +80,12 @@ Accept wildcard characters: False
 ```
 
 ### -Path
+
 Specifies a file path.
 This cmdlet writes the policy to the file that this parameter specifies.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: File
 Aliases: FilePath
 
@@ -91,12 +97,13 @@ Accept wildcard characters: False
 ```
 
 ### -SkipValidation
+
 Indicates that this cmdlet skips validation.
 
 ```yaml
-Type: SwitchParameter
+Type: System.Diagnostics.Switch
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -106,7 +113,11 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
@@ -117,4 +128,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
-