Skip to content

Commit 5786e16

Browse files
michaeltlombardimichaeltlombardi
authored
Merge pull request MicrosoftDocs#3498 from robderickson/robderickson-quality-iss3490
Quality: Address formatting in articles for some ActiveDirectory cmdlets (issue MicrosoftDocs#3490)
2 parents 9c89852 + a9a55b7 commit 5786e16

10 files changed

+1268
-874
lines changed

‎docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md

Lines changed: 138 additions & 76 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Enable-ADAccount.md

Lines changed: 123 additions & 81 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md

Lines changed: 121 additions & 80 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md

Lines changed: 131 additions & 76 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md

Lines changed: 140 additions & 89 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md

Lines changed: 142 additions & 93 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md

Lines changed: 135 additions & 87 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADCentralAccessPolicy.md

Lines changed: 114 additions & 103 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADCentralAccessRule.md

Lines changed: 116 additions & 106 deletions
Large diffs are not rendered by default.

‎docset/winserver2022-ps/activedirectory/Get-ADClaimTransformPolicy.md

Lines changed: 108 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -16,72 +16,86 @@ Returns one or more Active Directory claim transform objects based on a specifie
1616
## SYNTAX
1717

1818
### Filter (Default)
19+
1920
```
20-
Get-ADClaimTransformPolicy [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Filter <String>
21-
[-Properties <String[]>] [-Server <String>] [<CommonParameters>]
21+
Get-ADClaimTransformPolicy [-AuthType <ADAuthType>] [-Credential <PSCredential>]
22+
-Filter <String> [-Properties <String[]>] [-Server <String>] [<CommonParameters>]
2223
```
2324

2425
### Identity
26+
2527
```
2628
Get-ADClaimTransformPolicy [-AuthType <ADAuthType>] [-Credential <PSCredential>]
27-
[[-Identity] <ADClaimTransformPolicy>] [-Properties <String[]>] [-Server <String>] [<CommonParameters>]
29+
[[-Identity] <ADClaimTransformPolicy>] [-Properties <String[]>] [-Server <String>]
30+
[<CommonParameters>]
2831
```
2932

3033
### LdapFilter
34+
3135
```
32-
Get-ADClaimTransformPolicy [-AuthType <ADAuthType>] [-Credential <PSCredential>] -LDAPFilter <String>
33-
[-Properties <String[]>] [-Server <String>] [<CommonParameters>]
36+
Get-ADClaimTransformPolicy [-AuthType <ADAuthType>] [-Credential <PSCredential>]
37+
-LDAPFilter <String> [-Properties <String[]>] [-Server <String>] [<CommonParameters>]
3438
```
3539

3640
## DESCRIPTION
37-
The **Get-ADClaimTransformPolicy** cmdlet returns one or more Active Directory claim transform objects based on a specified filter.
41+
42+
The `Get-ADClaimTransformPolicy` cmdlet returns one or more Active Directory claim transform objects
43+
based on a specified filter.
3844

3945
## EXAMPLES
4046

4147
### Example 1: Get a list of all claims transformation policies
42-
```
43-
PS C:\> Get-ADClaimTransformPolicy -Filter *
48+
49+
```powershell
50+
Get-ADClaimTransformPolicy -Filter *
4451
```
4552

4653
This command retrieves a list of all claims transformation policies.
4754

4855
### Example 2: Get all the claims transformation policies that are applied to a specific trust
49-
```
50-
PS C:\> $Contoso = Get-ADTrust -Identity "corp.contoso.com"
51-
PS C:\> Get-ADClaimTransformPolicy -Filter "IncomingTrust -eq '$Contoso' -or OutgoingTrust -eq '$Contoso'"
56+
57+
```powershell
58+
$trust = Get-ADTrust -Identity "corp.contoso.com"
59+
$filter = "IncomingTrust -eq '$trust' -or OutgoingTrust -eq '$trust'"
60+
Get-ADClaimTransformPolicy -Filter $filter
5261
```
5362

54-
This example gets all the claims transformation policies that are applied to trusts made with corp.contoso.com.
63+
This example gets all the claims transformation policies that are applied to trusts made with
64+
`corp.contoso.com`.
5565

5666
### Example 3: Get the claims transformation policy with a specify policy name
57-
```
58-
PS C:\> Get-ADClaimTransformPolicy -Identity DenyAllPolicy
67+
68+
```powershell
69+
Get-ADClaimTransformPolicy -Identity DenyAllPolicy
5970
```
6071

61-
This command gets the claims transformation policy with the name DenyAllPolicy.
72+
This command gets the claims transformation policy with the name `DenyAllPolicy`.
6273

6374
### Example 4: Get information on claims using a LDAP based query filter
64-
```
65-
PS C:\> Get-ADClaimTransformPolicy -LDAPFilter "(name=DenyAll*)"
75+
76+
```powershell
77+
Get-ADClaimTransformPolicy -LDAPFilter "(name=DenyAll*)"
6678
```
6779

68-
This command gets information on any claims transformation policies using an LDAP-based query filter that looks for matches where policies have a name that starts with the word DenyAll.
80+
This command gets information on any claims transformation policies using an LDAP-based query filter
81+
that looks for matches where policies have a name that starts with the word `DenyAll`.
6982

7083
## PARAMETERS
7184

7285
### -AuthType
86+
7387
Specifies the authentication method to use.
7488
The acceptable values for this parameter are:
7589

76-
- Negotiate or 0
77-
- Basic or 1
90+
- `Negotiate` or `0`
91+
- `Basic` or `1`
7892

79-
The default authentication method is Negotiate.
93+
The default authentication method is `Negotiate`.
8094

81-
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
95+
A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method.
8296

8397
```yaml
84-
Type: ADAuthType
98+
Type: Microsoft.ActiveDirectory.Management.ADAuthType
8599
Parameter Sets: (All)
86100
Aliases:
87101
Accepted values: Negotiate, Basic
@@ -94,20 +108,24 @@ Accept wildcard characters: False
94108
```
95109
96110
### -Credential
97-
Specifies the user account credentials to use to perform this task.
98-
The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive.
99-
If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
100111
101-
To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object.
102-
If you specify a user name for this parameter, the cmdlet prompts for a password.
112+
Specifies the user account credentials to use to perform this task. The default credentials are the
113+
credentials of the currently logged on user unless the cmdlet is run from an Active Directory module
114+
for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account
115+
associated with the drive is the default.
116+
117+
To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can
118+
specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts
119+
for a password.
103120

104-
You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet.
105-
You can then set the *Credential* parameter to the **PSCredential** object.
121+
You can also create a **PSCredential** object by using a script or by using the `Get-Credential`
122+
cmdlet. You can then set the **Credential** parameter to the **PSCredential** object.
106123

107-
If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error.
124+
If the acting credentials do not have directory-level permission to perform the task, Active
125+
Directory module for Windows PowerShell returns a terminating error.
108126

109127
```yaml
110-
Type: PSCredential
128+
Type: System.Management.Automation.PSCredential
111129
Parameter Sets: (All)
112130
Aliases:
113131
@@ -119,38 +137,36 @@ Accept wildcard characters: False
119137
```
120138

121139
### -Filter
122-
Specifies a query string that retrieves Active Directory objects.
123-
This string uses the Windows PowerShell Expression Language syntax.
124-
The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter.
125-
The syntax uses an in-order representation, which means that the operator is placed between the operand and the value.
126-
For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`.
127140

128-
Syntax:
141+
Specifies a query string that retrieves Active Directory Domain Services objects. This string uses
142+
the Windows PowerShell expression language syntax. The Windows PowerShell expression language syntax
143+
provides rich type-conversion support for value types received by the **Filter** parameter.
129144

130-
The following syntax uses Backus-Naur form to show how to use the Windows PowerShell Expression Language for this parameter.
145+
Specify the **Filter** parameter in one of the following formats:
131146

132-
\<filter\> ::= "{" \<FilterComponentList\> "}"
147+
- To match a single filter element: `{Attribute operator "value"}`
148+
- To match multiple filter elements:
149+
`{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "value2")}`
133150

134-
\<FilterComponentList\> ::= \<FilterComponent\> | \<FilterComponent\> \<JoinOperator\> \<FilterComponent\> | \<NotOperator\> \<FilterComponent\>
151+
Windows PowerShell wildcards other than `*`, such as `?`, are not supported by the **Filter**
152+
syntax.
135153

136-
\<FilterComponent\> ::= \<attr\> \<FilterOperator\> \<value\> | "(" \<FilterComponent\> ")"
154+
Valid filter operators are:
137155

138-
\<FilterOperator\> ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike"
156+
`-eq`, `-le`, `-ge`, `-ne`, `-lt`, `-gt`, `-approx`, `-bor`, `-band`, `-recursivematch`, `-like`,
157+
`-notlike`
139158

140-
\<JoinOperator\> ::= "-and" | "-or"
159+
Valid join operators are:
141160

142-
\<NotOperator\> ::= "-not"
161+
`-and`, `-or`
143162

144-
\<attr\> ::= \<PropertyName\> | \<LDAPDisplayName of the attribute\>
163+
The not operator is `-not`.
145164

146-
\<value\>::= \<compare this value with an \<attr\> by using the specified \<FilterOperator\>\>
147-
148-
For a list of supported types for \<value\>, see about_ActiveDirectory_ObjectModel.
149-
150-
Note: To query using Lightweight Directory Access Protocol (LDAP) query strings, use the *LDAPFilter* parameter.
165+
For a list of supported types for values, see `about_ActiveDirectory_ObjectModel`. For more
166+
information about the **Filter** parameter, see `about_ActiveDirectory_Filter`.
151167

152168
```yaml
153-
Type: String
169+
Type: System.String
154170
Parameter Sets: Filter
155171
Aliases:
156172
@@ -162,19 +178,21 @@ Accept wildcard characters: False
162178
```
163179

164180
### -Identity
165-
Specifies an Active Directory object by providing one of the following property values.
166-
The identifier in parentheses is the LDAP display name for the attribute.
167-
The acceptable values for this parameter are:
181+
182+
Specifies an Active Directory object by providing one of the following property values. The
183+
identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this
184+
parameter are:
168185

169186
- A distinguished name
170187

171-
The cmdlet searches the default naming context or partition to find the object.
172-
If two or more objects are found, the cmdlet returns a non-terminating error.
188+
The cmdlet searches the default naming context or partition to find the object. If two or more
189+
objects are found, the cmdlet returns a non-terminating error.
173190

174-
This parameter can also get this object through the pipeline or you can set this parameter to an object instance.
191+
This parameter can also get this object through the pipeline or you can set this parameter to an
192+
object instance.
175193

176194
```yaml
177-
Type: ADClaimTransformPolicy
195+
Type: Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
178196
Parameter Sets: Identity
179197
Aliases:
180198
@@ -186,13 +204,12 @@ Accept wildcard characters: False
186204
```
187205

188206
### -LDAPFilter
189-
Specifies an LDAP query string that is used to filter Active Directory objects.
190-
You can use this parameter to run your existing LDAP queries.
191-
The *Filter* parameter syntax supports the same functionality as the LDAP syntax.
192-
For more information, see the *Filter* parameter description or type `Get-Help about_ActiveDirectory_Filter`.
207+
208+
Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory
209+
Domain Services objects.
193210

194211
```yaml
195-
Type: String
212+
Type: System.String
196213
Parameter Sets: LdapFilter
197214
Aliases:
198215
@@ -204,19 +221,18 @@ Accept wildcard characters: False
204221
```
205222

206223
### -Properties
207-
Specifies the properties of the output object to retrieve from the server.
208-
Use this parameter to retrieve properties that are not included in the default set.
209224

210-
Specify properties for this parameter as a comma-separated list of names.
211-
To display all of the attributes that are set on the object, specify * (asterisk).
225+
Specifies the properties of the output object to get from the server. Use this parameter to get
226+
properties that are not included in the default set.
212227

213-
To specify an individual extended property, use the name of the property.
214-
For properties that are not default or extended properties, you must specify the LDAP display name of the attribute.
228+
Specify the properties to get as a comma separated list of names. To display
229+
all of the properties that are set on the object, specify an asterisk (`*`) wildcard.
215230

216-
To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet.
231+
To specify an individual extended property, use the name of the property. For properties that are
232+
not default or extended properties, you must specify the LDAP display name of the attribute.
217233

218234
```yaml
219-
Type: String[]
235+
Type: System.String[]
220236
Parameter Sets: (All)
221237
Aliases: Property
222238
@@ -228,30 +244,35 @@ Accept wildcard characters: False
228244
```
229245

230246
### -Server
231-
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server.
232-
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance.
233247

234-
Specify the Active Directory Domain Services instance in one of the following ways:
248+
Specifies the Active Directory Domain Services instance to connect to, by providing one of the
249+
following values for a corresponding domain name or directory server. The service may be any of the
250+
following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active
251+
Directory snapshot instance.
252+
253+
Specify the Active Directory Domain Services instance in one of the following ways:
235254

236255
Domain name values:
237256

238257
- Fully qualified domain name
239258
- NetBIOS name
240259

241-
Directory server values:
260+
Directory server values:
242261

243262
- Fully qualified directory server name
244263
- NetBIOS name
245264
- Fully qualified directory server name and port
246265

247-
The default value for this parameter is determined by one of the following methods in the order that they are listed:
266+
The default value for this parameter is determined by one of the following methods in the order that
267+
they are listed:
248268

249-
- By using the *Server* value from objects passed through the pipeline
250-
- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive
269+
- By using the **Server** value from objects passed through the pipeline
270+
- By using the server information associated with the Active Directory Domain Services Windows
271+
PowerShell provider drive, when the cmdlet runs in that drive
251272
- By using the domain of the computer running Windows PowerShell
252273

253274
```yaml
254-
Type: String
275+
Type: System.String
255276
Parameter Sets: (All)
256277
Aliases:
257278
@@ -263,12 +284,17 @@ Accept wildcard characters: False
263284
```
264285

265286
### CommonParameters
266-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
287+
288+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
289+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
290+
-WarningAction, and -WarningVariable. For more information, see
291+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
267292

268293
## INPUTS
269294

270295
### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
271-
A claim transform policy object is received by the *Identity* parameter.
296+
297+
A claim transform policy object is received by the **Identity** parameter.
272298

273299
## OUTPUTS
274300

@@ -285,4 +311,3 @@ A claim transform policy object is received by the *Identity* parameter.
285311
[Set-ADClaimTransformPolicy](./Set-ADClaimTransformPolicy.md)
286312

287313
[AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md)
288-

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy