Skip to content

Commit 1280f77

Browse files
author
Joe Gast
committed
Grant-HgsKeyProtectorAccess.md - documentation formatting
1 parent a0f5476 commit 1280f77

File tree

3 files changed

+36
-25
lines changed

3 files changed

+36
-25
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ For more information about Windows PowerShell background jobs, see
6262
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
6363

6464
```yaml
65-
Type: SwitchParameter
65+
Type: System.Management.Automation.SwitchParameter
6666
Parameter Sets: (All)
6767
Aliases:
6868

@@ -79,7 +79,7 @@ Specifies the existing key protector as a byte array. This cmdlet generates a ke
7979
from the existing key protector that this parameter specifies.
8080
8181
```yaml
82-
Type: Byte[]
82+
Type: System.Byte[]
8383
Parameter Sets: (All)
8484
Aliases:
8585

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Accept wildcard characters: False
5959
Specifies the path to the file to write an XML representation of the guardian.
6060
6161
```yaml
62-
Type: String
62+
Type: System.String
6363
Parameter Sets: (All)
6464
Aliases: FilePath
6565

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

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,54 @@ Grants access to a guardian for a key protector.
1616
## SYNTAX
1717

1818
### InputObject
19+
1920
```
20-
Grant-HgsKeyProtectorAccess -KeyProtector <CimInstance> -Guardian <CimInstance> [-AllowUntrustedRoot]
21-
[-AllowExpired] [<CommonParameters>]
21+
Grant-HgsKeyProtectorAccess -KeyProtector <CimInstance> -Guardian <CimInstance>
22+
[-AllowUntrustedRoot] [-AllowExpired] [<CommonParameters>]
2223
```
2324

2425
### FriendlyName
2526
```
26-
Grant-HgsKeyProtectorAccess -KeyProtector <CimInstance> -GuardianFriendlyName <String> [-AllowUntrustedRoot]
27-
[-AllowExpired] [<CommonParameters>]
27+
Grant-HgsKeyProtectorAccess -KeyProtector <CimInstance> -GuardianFriendlyName <String>
28+
[-AllowUntrustedRoot] [-AllowExpired] [<CommonParameters>]
2829
```
2930

3031
## DESCRIPTION
32+
3133
The **Grant-HgsKeyProtectorAccess** cmdlet grants a Host Guardian Service guardian access to a key protector.
3234
This operation requires the private signing key of the owner of the key protector.
3335

3436
## EXAMPLES
3537

3638
### Example 1: Grant access to a guardian
37-
```
38-
PS C:\> $Owner = Get-HgsGuardian -Name "Guardian06"
39-
PS C:\> $Guardian01 = Get-HgsGuardian -Name "Guardian11"
40-
PS C:\> $KeyProtector = New-HgsKeyProtector -Owner $Owner
41-
PS C:\> Grant-HgsKeyProtectorAccess -KeyProtector $KeyProtector -Guardian $Guardian01
39+
40+
```powershell
41+
$Owner = Get-HgsGuardian -Name "Guardian06"
42+
$Guardian01 = Get-HgsGuardian -Name "Guardian11"
43+
$KeyProtector = New-HgsKeyProtector -Owner $Owner
44+
Grant-HgsKeyProtectorAccess -KeyProtector $KeyProtector -Guardian $Guardian01
4245
```
4346

44-
The first command gets the guardian object named Guardian06 by using the **Get-HgsGuardian** cmdlet, and then stores that object in the **$Owner** variable.
47+
The first command gets the guardian object named `Guardian06` by using the `Get-HgsGuardian` cmdlet,
48+
and then stores that object in the `$Owner` variable.
4549

46-
The second commands get the guardian object named Guardian11, and then stores it in the **$Guardian01** variable.
50+
The second commands get the guardian object named `Guardian11`, and then stores it in the `$Guardian01` variable.
4751

4852
The third command creates a key protector.
49-
The command defines Guardian06, stored in **$Owner**, as the **Owner**.
53+
The command defines `Guardian06`, stored in `$Owner`, as the **Owner**.
5054

51-
The final command grants access to the guardian stored in **$Guardian01** for the key protector.
55+
The final command grants access to the guardian stored in `$Guardian01` for the key protector.
5256

5357
## PARAMETERS
5458

5559
### -AllowExpired
60+
5661
Indicates that this cmdlet can grant permissions to a guardian that contains certificates that are expired.
5762

5863
```yaml
5964
Type: SwitchParameter
6065
Parameter Sets: (All)
61-
Aliases:
66+
Aliases:
6267

6368
Required: False
6469
Position: Named
@@ -68,12 +73,13 @@ Accept wildcard characters: False
6873
```
6974
7075
### -AllowUntrustedRoot
76+
7177
Indicates that this cmdlet can grant permissions to a guardian that uses self-signed certificates.
7278
7379
```yaml
7480
Type: SwitchParameter
7581
Parameter Sets: (All)
76-
Aliases:
82+
Aliases:
7783

7884
Required: False
7985
Position: Named
@@ -83,12 +89,13 @@ Accept wildcard characters: False
8389
```
8490
8591
### -Guardian
92+
8693
Specifies a guardian to which to grant access to the key.
8794
8895
```yaml
8996
Type: CimInstance
9097
Parameter Sets: InputObject
91-
Aliases:
98+
Aliases:
9299

93100
Required: True
94101
Position: Named
@@ -98,12 +105,13 @@ Accept wildcard characters: False
98105
```
99106
100107
### -GuardianFriendlyName
108+
101109
Specifies a friendly name for the guardian.
102110
103111
```yaml
104112
Type: String
105113
Parameter Sets: FriendlyName
106-
Aliases:
114+
Aliases:
107115

108116
Required: True
109117
Position: Named
@@ -113,12 +121,13 @@ Accept wildcard characters: False
113121
```
114122
115123
### -KeyProtector
124+
116125
Specifies the key protector to which to grant access.
117126
118127
```yaml
119128
Type: CimInstance
120129
Parameter Sets: (All)
121-
Aliases:
130+
Aliases:
122131

123132
Required: True
124133
Position: Named
@@ -128,15 +137,18 @@ Accept wildcard characters: False
128137
```
129138
130139
### CommonParameters
131-
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).
140+
141+
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).
132142
133143
## INPUTS
134144
135145
## OUTPUTS
136146
137147
### CimInstance#MSFT_HgsKeyProtector
138-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
139-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
148+
149+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
150+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
151+
namespace and class name for the underlying WMI object.
140152

141153
## NOTES
142154

@@ -147,4 +159,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th
147159
[Revoke-HgsKeyProtectorAccess](./Revoke-HgsKeyProtectorAccess.md)
148160

149161
[Get-HgsGuardian](./Get-HgsGuardian.md)
150-

0 commit comments

Comments
 (0)