You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 20, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+6-5Lines changed: 6 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,18 @@
2
2
3
3
# Overview
4
4
This repository holds reference content of Office PowerShell cmdlets for help purpose. The expert knowledge around Office PowerShell is distributed among customers, MVPs, partners, product teams, support, and other community members. Consumers have various preferences when consuming knowledge such as a website, PowerShell Get-Help, Windows app, iOS app, Android app, and others. The following diagram illustrates the point.
5
+
5
6
6
7
7
-
# Learn How To Contribute
8
+
##Learn How To Contribute
8
9
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
9
10
Your contributions will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
10
11
11
12
> Notice that if you are looking into contributing for the **PnP PowerShell cmdlets**, their documentation is automatically generated from the code, and you should be submitting your change towards the original code at https://github.com/SharePoint/PnP-powershell. See, for example, how the attributes are used in the code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet.
12
13
13
-
# Quick Start
14
+
##Quick Start
14
15
15
-
## Contribute using the GitHub website
16
+
###Contribute using the GitHub website
16
17
17
18
[](https://support.office.com/en-us/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf?ui=en-US&rs=en-US&ad=US)
18
19
@@ -42,9 +43,9 @@ Looking for more in-depth content? Check out the following:
42
43
*[Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md)
43
44
*[Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md)
44
45
45
-
# Microsoft Open Source Code of Conduct
46
+
##Microsoft Open Source Code of Conduct
46
47
47
-
## Contributing
48
+
###Contributing
48
49
49
50
This project welcomes contributions and suggestions. Most contributions require you to agree to a
50
51
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
This parameter is available only in Exchange 2013.
93
+
94
+
The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are:
95
+
96
+
- None: This is the default setting.
97
+
98
+
- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel.
99
+
100
+
- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting.
101
+
102
+
- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter.
103
+
104
+
- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server.
105
+
106
+
```yaml
107
+
Type: MultiValuedProperty
108
+
Parameter Sets: (All)
109
+
Aliases:
110
+
Applicable: Exchange Server 2013
111
+
Required: False
112
+
Position: Named
113
+
Default value: None
114
+
Accept pipeline input: False
115
+
Accept wildcard characters: False
116
+
```
117
+
118
+
### -ExtendedProtectionSPNList
119
+
This parameter is available only in Exchange 2013.
120
+
121
+
The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are:
122
+
123
+
- $null: This is the default value.
124
+
125
+
- Single SPN or comma delimited list of valid SPNs: The SPN value format is \<protocol\>/\<FQDN\>. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter.
126
+
127
+
```yaml
128
+
Type: MultiValuedProperty
129
+
Parameter Sets: (All)
130
+
Aliases:
131
+
Applicable: Exchange Server 2013
132
+
Required: False
133
+
Position: Named
134
+
Default value: None
135
+
Accept pipeline input: False
136
+
Accept wildcard characters: False
137
+
```
138
+
139
+
### -ExtendedProtectionTokenChecking
140
+
This parameter is available only in Exchange 2013.
141
+
142
+
The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are:
143
+
144
+
- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value.
145
+
146
+
- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication.
147
+
148
+
- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter.
149
+
150
+
Note:
151
+
152
+
If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter.
153
+
154
+
```yaml
155
+
Type: None | Allow | Require
156
+
Parameter Sets: (All)
157
+
Aliases:
158
+
Applicable: Exchange Server 2013
159
+
Required: False
160
+
Position: Named
161
+
Default value: None
162
+
Accept pipeline input: False
163
+
Accept wildcard characters: False
164
+
```
165
+
80
166
### -ExternalUrl
81
167
The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall.
82
168
@@ -142,6 +228,29 @@ Accept pipeline input: False
142
228
Accept wildcard characters: False
143
229
```
144
230
231
+
### -Role
232
+
This parameter is available only in Exchange 2013.
233
+
234
+
The Role parameter species the configuration for the virtual directory. Valid values are:
235
+
236
+
- ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server.
237
+
238
+
- Mailbox: Configure the virtual directory for the backend services on the Mailbox server.
239
+
240
+
Client connections are proxied from the Client Access services to the backend services on local or remote Mailbox servers. Clients don't connect directly to the backend services.
241
+
242
+
```yaml
243
+
Type: ClientAccess | Mailbox
244
+
Parameter Sets: (All)
245
+
Aliases:
246
+
Applicable: Exchange Server 2013
247
+
Required: False
248
+
Position: Named
249
+
Default value: None
250
+
Accept pipeline input: False
251
+
Accept wildcard characters: False
252
+
```
253
+
145
254
### -Server
146
255
The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example:
147
256
@@ -165,29 +274,29 @@ Accept pipeline input: True
165
274
Accept wildcard characters: False
166
275
```
167
276
168
-
### -WhatIf
169
-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
277
+
### -WebSiteName
278
+
The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website.
170
279
171
280
```yaml
172
-
Type: SwitchParameter
281
+
Type: String
173
282
Parameter Sets: (All)
174
-
Aliases:wi
175
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
283
+
Aliases:
284
+
Applicable: Exchange Server 2016, Exchange Server 2019
176
285
Required: False
177
286
Position: Named
178
287
Default value: None
179
288
Accept pipeline input: False
180
289
Accept wildcard characters: False
181
290
```
182
291
183
-
### -WebSiteName
184
-
The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website.
292
+
### -WhatIf
293
+
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
185
294
186
295
```yaml
187
-
Type: String
296
+
Type: SwitchParameter
188
297
Parameter Sets: (All)
189
-
Aliases:
190
-
Applicable: Exchange Server 2016, Exchange Server 2019
298
+
Aliases:wi
299
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in Exchange 2013.
133
+
134
+
The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are:
135
+
136
+
- None: This is the default setting.
137
+
138
+
- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel.
139
+
140
+
- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting.
141
+
142
+
- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter.
143
+
144
+
- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server.
145
+
146
+
```yaml
147
+
Type: MultiValuedProperty
148
+
Parameter Sets: (All)
149
+
Aliases:
150
+
Applicable: Exchange Server 2013
151
+
Required: False
152
+
Position: Named
153
+
Default value: None
154
+
Accept pipeline input: False
155
+
Accept wildcard characters: False
156
+
```
157
+
158
+
### -ExtendedProtectionSPNList
159
+
This parameter is available only in Exchange 2013.
160
+
161
+
The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are:
162
+
163
+
- $null: This is the default value.
164
+
165
+
- Single SPN or comma delimited list of valid SPNs: The SPN value format is \<protocol\>/\<FQDN\>. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter.
166
+
167
+
```yaml
168
+
Type: MultiValuedProperty
169
+
Parameter Sets: (All)
170
+
Aliases:
171
+
Applicable: Exchange Server 2013
172
+
Required: False
173
+
Position: Named
174
+
Default value: None
175
+
Accept pipeline input: False
176
+
Accept wildcard characters: False
177
+
```
178
+
179
+
### -ExtendedProtectionTokenChecking
180
+
This parameter is available only in Exchange 2013.
181
+
182
+
The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are:
183
+
184
+
- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value.
185
+
186
+
- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication.
187
+
188
+
- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter.
189
+
190
+
Note:
191
+
192
+
If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter.
193
+
194
+
```yaml
195
+
Type: None | Allow | Require
196
+
Parameter Sets: (All)
197
+
Aliases:
198
+
Applicable: Exchange Server 2013
199
+
Required: False
200
+
Position: Named
201
+
Default value: None
202
+
Accept pipeline input: False
203
+
Accept wildcard characters: False
204
+
```
205
+
123
206
### -ExternalUrl
124
207
The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall.
Copy file name to clipboardExpand all lines: exchange/exchange-ps/exchange/client-access/Test-OutlookConnectivity.md
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -89,9 +89,10 @@ Running the Test-OutlookConnectivity cmdlet validates an Outlook connection defi
89
89
90
90
The Test-OutlookConnectivity cmdlet runs the same process as the monitoring probes. The Microsoft Exchange Health Manager (MSExchangeHM) service must be running and have created the Outlook probes on the machine that will be tested. You need to select one of the Outlook probe identities to run the test. Use the Get-MonitoringItemIdentity (https://go.microsoft.com/fwlink/p/?LinkId=510841) cmdlet to see what probes are active.
91
91
92
-
This example lists the probes running in the backend services on a Mailbox server.
92
+
This example lists the probes running in the backend services on a Mailbox server: `Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook.protocol | ?{$_.Name -like '*probe'}`.
93
93
94
-
This example lists the probes running in the client access services on a Mailbox server.
94
+
95
+
This example lists the probes running in the client access services on a Mailbox server: `Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook | ?{$_.Name -like '*probe'}`.
95
96
96
97
For more information on probes and the monitoring framework, see Managed Availability (https://go.microsoft.com/fwlink/p/?LinkId=510838), Managed Availability and Server Health (https://go.microsoft.com/fwlink/p/?LinkId=510839), and Customizing Managed Availability (https://go.microsoft.com/fwlink/p/?LinkId=510840)
The DefaultAccessLevel parameter specifies the access level for new devices. Valid values are Allow,Block or Quarantine. The default value is Allow.
114
+
The DefaultAccessLevel parameter specifies the access level for new and existing device partnerships. Valid values are:
115
+
116
+
- Allow (This is the default value)
117
+
118
+
- Block
119
+
120
+
- Quarantine
121
+
122
+
If you change this value from Allow to Block or Quarantine, all existing connected devices are immediately affected, unless the devices are subject to device access rules or individual allow or block list entries.
This parameter is available or functional only in Exchange Server 2010.
89
91
90
-
The IncludeMailboxSettingOnlyPolicy parameter retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. Microsoft Exchange Server 2010 supports both policies that contain only address policy settings and policies that contain address policy settings and mailbox management configuration. Exchange 2010 doesn't support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. The IncludeMailboxSettingOnlyPolicy parameter is required to retrieve these policies.
92
+
The IncludeMailboxSettingOnlyPolicy parameter retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. Microsoft Exchange Server 2010 supports both policies that contain only address policy settings and policies that contain address policy settings and mailbox management configuration. Exchange 2010 doesn't support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. The IncludeMailboxSettingOnlyPolicy parameter is required to retrieve these policies.
91
93
92
-
The attributes of address policies that contain only mailbox management configuration can't be modified in Exchange 2010. These policies can only be removed.
94
+
The attributes of address policies that contain only mailbox management configuration can't be modified in Exchange 2010. These policies can only be removed.
0 commit comments