Skip to content

Commit c53ff60

Browse files
author
Joe Gast
committed
ConvertTo-HGSKeyProtector.md - documentation formatting
1 parent bd7d419 commit c53ff60

File tree

1 file changed

+53
-36
lines changed

1 file changed

+53
-36
lines changed

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

Lines changed: 53 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,55 @@ Converts a key protector into a Host Guardian Service key protector.
1616
## SYNTAX
1717

1818
```
19-
ConvertTo-HgsKeyProtector [-Bytes] <Byte[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
ConvertTo-HgsKeyProtector [-Bytes] <Byte[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
20+
[-AsJob] [<CommonParameters>]
2121
```
2222

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

2829
## EXAMPLES
2930

3031
### Example 1: Convert a key protector
31-
```
32-
PS C:\> $VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17"
33-
PS C:\> $VirtualMachineKeyProtector = $VirtualTPM.KeyProtector
34-
PS C:\> $KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector
32+
33+
```powershell
34+
$VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17"
35+
$VirtualMachineKeyProtector = $VirtualTPM.KeyProtector
36+
$KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector
3537
```
3638

37-
The first command gets the Trusted Platform Module (TPM) object for the virtual machine named Shielded Virtual Machine 17.
38-
The command stores the object in the **$VirtualTPM** variable.
39+
The first command gets the Trusted Platform Module (TPM) object for the virtual machine named
40+
Shielded Virtual Machine 17. The command stores the object in the **$VirtualTPM** variable.
3941

40-
The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in the **$VirtualMachineKeyProtector** variable.
42+
The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in
43+
the **$VirtualMachineKeyProtector** variable.
4144

42-
The final command creates a Host Guardian Service key protector object from the byte array representation stored in **$VirtualMachineKeyProtector**.
43-
The command stores the new key protector in the **$KeyProtector** variable.
45+
The final command creates a Host Guardian Service key protector object from the byte array
46+
representation stored in **$VirtualMachineKeyProtector**. The command stores the new key protector
47+
in the **$KeyProtector** variable.
4448

4549
## PARAMETERS
4650

4751
### -AsJob
48-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4952

50-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
51-
You can continue to work in the session while the job completes.
52-
To manage the job, use the `*-Job` cmdlets.
53-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
53+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
54+
complete.
5455

55-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
56+
The cmdlet immediately returns an object that represents the job and then displays the command
57+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
58+
`*-Job` cmdlets. To get the job results, use the
59+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
5660

61+
For more information about Windows PowerShell background jobs, see
62+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5763

5864
```yaml
5965
Type: SwitchParameter
6066
Parameter Sets: (All)
61-
Aliases:
67+
Aliases:
6268

6369
Required: False
6470
Position: Named
@@ -68,13 +74,14 @@ Accept wildcard characters: False
6874
```
6975
7076
### -Bytes
71-
Specifies the existing key protector as a byte array.
72-
This cmdlet generates a key protector object from the existing key protector that this parameter specifies.
77+
78+
Specifies the existing key protector as a byte array. This cmdlet generates a key protector object
79+
from the existing key protector that this parameter specifies.
7380
7481
```yaml
7582
Type: Byte[]
7683
Parameter Sets: (All)
77-
Aliases:
84+
Aliases:
7885

7986
Required: True
8087
Position: 1
@@ -84,9 +91,11 @@ Accept wildcard characters: False
8491
```
8592
8693
### -CimSession
87-
Runs the cmdlet in a remote session or on a remote computer.
88-
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.
89-
The default is the current session on the local computer.
94+
95+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
96+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
97+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
98+
current session on the local computer.
9099
91100
```yaml
92101
Type: CimSession[]
@@ -101,14 +110,17 @@ Accept wildcard characters: False
101110
```
102111
103112
### -ThrottleLimit
104-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
105-
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.
106-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
113+
114+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
115+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
116+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
117+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
118+
computer.
107119

108120
```yaml
109121
Type: Int32
110122
Parameter Sets: (All)
111-
Aliases:
123+
Aliases:
112124
113125
Required: False
114126
Position: Named
@@ -118,21 +130,26 @@ Accept wildcard characters: False
118130
```
119131

120132
### CommonParameters
121-
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).
133+
134+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
135+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
136+
-WarningAction, and -WarningVariable. For more information, see
137+
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
122138

123139
## INPUTS
124140

125141
## OUTPUTS
126142

127143
### Microsoft.Management.Infrastructure.CimInstance#MSFT_HgsKeyProtector
144+
128145
This cmdlet returns a key protector.
129146

130-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
131-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
147+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
148+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
149+
namespace and class name for the underlying WMI object.
132150

133151
## NOTES
134152

135153
## RELATED LINKS
136154

137-
[New-HgsKeyProtector](./New-HgsKeyProtector.md)
138-
155+
[New-HgsKeyProtector](./New-HgsKeyProtector.md)

0 commit comments

Comments
 (0)