Skip to content

Commit 15ed2ad

Browse files
Apply suggestions from code review
Co-authored-by: Mikey Lombardi (He/Him) <[email protected]>
1 parent e4274fc commit 15ed2ad

6 files changed

+29
-27
lines changed

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ ConvertTo-HgsKeyProtector [-Bytes] <Byte[]> [-CimSession <CimSession[]>] [-Throt
2323

2424
## DESCRIPTION
2525

26-
The **ConvertTo-HgsKeyProtector** cmdlet converts an existing key protector into a Host Guardian
27-
Service key protector object. Specify the existing key protector as a byte array. You might use this
28-
cmdlet to import a key protector from a virtual machine configuration file.
26+
The `ConvertTo-HgsKeyProtector` cmdlet converts an existing key protector into a Host Guardian
27+
Service key protector object. Specify the existing key protector as a byte array. You might use
28+
this cmdlet to import a key protector from a virtual machine configuration file.
2929

3030
## EXAMPLES
3131

@@ -38,14 +38,14 @@ $KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector
3838
```
3939

4040
The first command gets the Trusted Platform Module (TPM) object for the virtual machine named
41-
Shielded Virtual Machine 17. The command stores the object in the **$VirtualTPM** variable.
41+
Shielded Virtual Machine 17. The command stores the object in the `$VirtualTPM` variable.
4242

43-
The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in
44-
the **$VirtualMachineKeyProtector** variable.
43+
The second command stores the **KeyProtector** property of the object stored in `$VirtualTPM` in
44+
the `$VirtualMachineKeyProtector` variable.
4545

4646
The final command creates a Host Guardian Service key protector object from the byte array
47-
representation stored in **$VirtualMachineKeyProtector**. The command stores the new key protector
48-
in the **$KeyProtector** variable.
47+
representation stored in `$VirtualMachineKeyProtector`. The command stores the new key protector
48+
in the `$KeyProtector` variable.
4949

5050
## PARAMETERS
5151

@@ -145,7 +145,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
145145

146146
This cmdlet returns a key protector.
147147

148-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
148+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
149149
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
150150
namespace and class name for the underlying WMI object.
151151

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

+5-3
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,18 @@ Export-HgsGuardian [-InputObject] <CimInstance> [-Path] <String> [<CommonParamet
2121

2222
## DESCRIPTION
2323

24-
The **Export-HgsGuardian** cmdlet exports a guardian that contains public keys to an .xml file.
24+
The `Export-HgsGuardian` cmdlet exports a guardian that contains public keys to an `.xml` file.
2525

2626
## EXAMPLES
2727

2828
### Example 1: Export a guardian
2929

3030
```powershell
31-
Get-HgsGuardian -Name "Guardian11" | Export-HGsGuardian -Path "C:\LocalHGSFiles\Guardian11.xml"
31+
Get-HgsGuardian -Name 'Guardian11' |
32+
Export-HGsGuardian -Path 'C:\LocalHGSFiles\Guardian11.xml'
3233
```
3334

34-
This command uses the **Get-HgsGuardian** cmdlet to get the guardian named `Guardian11`, and then
35+
This command uses the `Get-HgsGuardian` cmdlet to get the guardian named `Guardian11`, and then
3536
passes the object to the current cmdlet by using the pipeline operator. That cmdlet exports the
3637
guardian to the specified file.
3738

@@ -40,6 +41,7 @@ guardian to the specified file.
4041
### -InputObject
4142

4243
Specifies the input to this cmdlet.
44+
4345
You can use this parameter, or you can pipe the input to this cmdlet.
4446

4547
```yaml

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Get-HgsAttestationBaselinePolicy [-Console] [-SkipValidation] [<CommonParameters
2727

2828
## DESCRIPTION
2929

30-
The **Get-HgsAttestationBaselinePolicy** cmdlet generates an attestation baseline policy. You can
31-
use the policy to configure the attestation service.
30+
The `Get-HgsAttestationBaselinePolicy` cmdlet generates an attestation baseline policy. You can use
31+
the policy to configure the attestation service.
3232

3333
This cmdlet gets a byte array that represents the attestation baseline policy from the raw data of
3434
the last full boot from the Trusted Computing Group log of the Trusted Platform Module (TPM).
@@ -40,7 +40,7 @@ Be sure to run this cmdlet on a host that is known to have good configuration.
4040
### Example 1: Generate a baseline policy
4141

4242
```powershell
43-
PS C:\> Get-HgsAttestationBaselinePolicy -Path "C:\Logs\AttestationBaselinePolicy001" -Force
43+
Get-HgsAttestationBaselinePolicy -Path 'C:\Logs\AttestationBaselinePolicy001' -Force
4444
```
4545

4646
This command generates a byte array that represents the baseline policy in the file `C:\Logs\AttestationBaselinePolicy001`.

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Get-HgsClientConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
2222

2323
## DESCRIPTION
2424

25-
The **Get-HgsClientConfiguration** cmdlet get the configuration of the local Host Guardian Service
25+
The `Get-HgsClientConfiguration` cmdlet get the configuration of the local Host Guardian Service
2626
client.
2727

2828
## EXAMPLES
2929

3030
### Example 1: Get client configuration
3131

3232
```powershell
33-
PS C:\> Get-HgsClientConfiguration
33+
Get-HgsClientConfiguration
3434
```
3535

3636
This command gets the configuration of the local Host Guardian Service client.
@@ -115,7 +115,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
115115
### CimInstance#MSFT_HgsClientConfiguration
116116

117117
This cmdlet returns the configuration of a Host Guardian Service client as a **CimInstance** object.
118-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
118+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
119119
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
120120
namespace and class name for the underlying WMI object.
121121

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ Get-HgsGuardian [[-Name] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimi
2222

2323
## DESCRIPTION
2424

25-
The **Get-HgsGuardian** cmdlet gets Host Guardian Service guardian objects from persistent storage.
26-
For a computer configured in **HostGuardianService** mode, this cmdlet returns no result.
27-
The **New-HgsKeyProtector** cmdlet requires **HgsGuardian** objects.
25+
The `Get-HgsGuardian` cmdlet gets Host Guardian Service guardian objects from persistent storage.
26+
For a computer configured in `HostGuardianService` mode, this cmdlet returns no result. The
27+
`New-HgsKeyProtector` cmdlet requires **HgsGuardian** objects.
2828

2929
## EXAMPLES
3030

@@ -39,7 +39,7 @@ This command gets all guardians configured for this computer.
3939
### Example 2: Get a guardian by using its name
4040

4141
```powershell
42-
PS C:\> Get-HgsGuardian -Name "Guardian11"
42+
Get-HgsGuardian -Name 'Guardian11'
4343
```
4444

4545
This command gets a guardian named Guardian11.

docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ Grant-HgsKeyProtectorAccess -KeyProtector <CimInstance> -GuardianFriendlyName <S
3030

3131
## DESCRIPTION
3232

33-
The **Grant-HgsKeyProtectorAccess** cmdlet grants a Host Guardian Service guardian access to a key protector.
34-
This operation requires the private signing key of the owner of the key protector.
33+
The `Grant-HgsKeyProtectorAccess` cmdlet grants a Host Guardian Service guardian access to a key
34+
protector. This operation requires the private signing key of the owner of the key protector.
3535

3636
## EXAMPLES
3737

3838
### Example 1: Grant access to a guardian
3939

4040
```powershell
41-
$Owner = Get-HgsGuardian -Name "Guardian06"
42-
$Guardian01 = Get-HgsGuardian -Name "Guardian11"
41+
$Owner = Get-HgsGuardian -Name "Guardian06"
42+
$Guardian01 = Get-HgsGuardian -Name "Guardian11"
4343
$KeyProtector = New-HgsKeyProtector -Owner $Owner
4444
Grant-HgsKeyProtectorAccess -KeyProtector $KeyProtector -Guardian $Guardian01
4545
```
@@ -146,7 +146,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
146146
147147
### CimInstance#MSFT_HgsKeyProtector
148148
149-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
149+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
150150
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
151151
namespace and class name for the underlying WMI object.
152152

0 commit comments

Comments
 (0)