Skip to content

Commit 9e88ebd

Browse files
committed
Merge branch 'master' of github.com:MicrosoftDocs/office-docs-powershell
2 parents 67f58d8 + 7a2b0be commit 9e88ebd

31 files changed

+262
-206
lines changed

exchange/exchange-ps/exchange/antispam-antimalware/Export-QuarantineMessage.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ monikerRange: "exchonline-ps || eop-ps"
1111
## SYNOPSIS
1212
This cmdlet is available only in the cloud-based service.
1313

14-
Use the Export-QuarantineMessage cmdlet to export quarantined messages from your cloud-based organization to .eml message files. You can then open the .eml files in Outlook.
14+
Use the Export-QuarantineMessage cmdlet to export quarantined messages and files from your cloud-based organization. Messages are exported to .eml message files so you can open them in Outlook.
15+
16+
For files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the files are exported in Base64 format.
1517

1618
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
1719

@@ -43,6 +45,13 @@ Notes:
4345

4446
- You need to use the Out-File cmdlet to write the .eml message file with the required encoding. If you use the default PowerShell redirection operator ">" to write the output file, the default encoding is Unicode, which might not match the actual message encoding.
4547

48+
### -------------------------- Example 2 --------------------------
49+
```
50+
$e = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111; $bytes = [Convert]::FromBase64String($e.eml); [IO.File]::WriteAllBytes("C:\My Documents\Export1.txt", $bytes)
51+
```
52+
53+
This example exports the quarantined file with the specified Identity value. The first command exports the file to a Base 64 string. The next two commands convert the string to byte format and write it to the output file.
54+
4655
## PARAMETERS
4756

4857
### -Identity

exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessage.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ monikerRange: "exchonline-ps || eop-ps"
1111
## SYNOPSIS
1212
This cmdlet is available only in the cloud-based service.
1313

14-
Use the Get-QuarantineMessage cmdlet to view quarantined messages in your cloud-based organization.
14+
Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization.
15+
16+
**Not**: Quarantined files are files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams.
1517

1618
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
1719

@@ -62,6 +64,15 @@ This example returns the quarantined message with the Message-ID value \<5c695d7
6264
Get-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 | Format-List
6365
```
6466

67+
This example returns detailed information for the quarantined message with the specified Identity value.
68+
69+
### -------------------------- Example 5 --------------------------
70+
```
71+
Get-QuarantineMessage -QuarantineTypes SPOMalware | Format-List
72+
```
73+
74+
This example returns detailed information for the files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams.
75+
6576
## PARAMETERS
6677

6778
### -Identity
@@ -216,12 +227,16 @@ The QuarantineTypes parameter filters the results by what caused the message to
216227
217228
- Spam
218229
230+
- SPOMalware
231+
219232
- TransportRule
220233
221234
You can specify multiple values separated by commas.
222235
223236
You don't need to use this parameter with the Type parameter.
224237
238+
For files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the detection information can be found in CustomData field in the output.
239+
225240
```yaml
226241
Type: QuarantineMessageTypeEnum[]
227242
Parameter Sets: Set1

exchange/exchange-ps/exchange/antispam-antimalware/Preview-QuarantineMessage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ This cmdlet is available only in the cloud-based service.
1313

1414
Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization.
1515

16+
**Note**: This cmdlet isn't available for files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business, and Microsoft Teams.
17+
1618
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
1719

1820
## SYNTAX

exchange/exchange-ps/exchange/antispam-antimalware/Release-QuarantineMessage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
13
---
24
external help file: Microsoft.Exchange.ServerStatus-Help.xml
35
applicable: Exchange Online, Exchange Online Protection
@@ -13,6 +15,8 @@ This cmdlet is available only in the cloud-based service.
1315

1416
Use the Release-QuarantineMessage cmdlet to release messages from quarantine in your cloud-based organization. You can release messages to all original recipients, or to specific recipients.
1517

18+
For files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files.
19+
1620
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
1721

1822
## SYNTAX
@@ -133,6 +137,8 @@ Accept wildcard characters: False
133137
### -ReleaseToAll
134138
The ReleaseToAll switch releases the quarantined message to all original recipients. You don't have to specify a value with this switch.
135139
140+
This parameter is required for the quarantine type SPOMalware.
141+
136142
If you previously used the User parameter or the ReleaseToAll switch to release the quarantined message to some or all of the original recipients, those recipients are skipped when you use the ReleaseToAll parameter again. You don't have to specify a value with the ReleaseToAll switch.
137143
138144
You can't use the ReleaseToAll switch and the User parameter in the same command.

exchange/exchange-ps/exchange/mailboxes/Search-Mailbox.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ You can use the Search-Mailbox cmdlet to search messages in a specified mailbox
4646

4747
- Delete messages from the source mailbox. You have to be assigned the Mailbox Import Export management role to delete messages.
4848

49-
- Copy messages from the source mailbox and delete them from the target mailbox.
50-
5149
- Perform single item recovery to recover items from a user's Recoverable Items folder.
5250

5351
- Clean up the Recoverable Items folder for a mailbox when it has reached the Recoverable Items hard quota.

sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectDatabaseUsage.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-SPProjectDatabaseUsage
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Returns an approximate size, in megabytes (MB) of the Project Web App data used in the content database.
1212

1313
## SYNTAX
1414

@@ -17,21 +17,23 @@ Get-SPProjectDatabaseUsage [-AssignmentCollection <SPAssignmentCollection>] -Url
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
Returns an approximate size, in megabytes (MB) of the Project Web App data used in the content database.
2121

2222
## EXAMPLES
2323

2424
### Example 1
2525
```
26-
PS C:\> {{ Add example code here }}
26+
PS C:\>Get-SPProjectDatabaseUsage -Url http://contoso.com/sites/pwa
2727
```
2828

29-
{{ Add example description here }}
29+
This example shows the size of the Project Web App data in the content data for the Project Web App site at http://contoso.com/sites/pwa.
3030

3131
## PARAMETERS
3232

3333
### -AssignmentCollection
34-
{{Fill AssignmentCollection Description}}
34+
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
35+
36+
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
3537

3638
```yaml
3739
Type: SPAssignmentCollection
@@ -47,7 +49,7 @@ Accept wildcard characters: False
4749
```
4850
4951
### -Url
50-
{{Fill Url Description}}
52+
The URL of the Project Web App site collection.
5153
5254
```yaml
5355
Type: Uri

sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEnterpriseProjectTaskSync.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-SPProjectEnterpriseProjectTaskSync
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Returns whether the task list sync between Project Web App and project sites is enabled or disabled. This cmdlet returns a value only if the feature has previously been enabled or disabled.
1212

1313
## SYNTAX
1414

@@ -18,21 +18,23 @@ Get-SPProjectEnterpriseProjectTaskSync [-AssignmentCollection <SPAssignmentColle
1818
```
1919

2020
## DESCRIPTION
21-
{{Fill in the Description}}
21+
Returns whether the task list sync between Project Web App and project sites is enabled or disabled. This cmdlet returns a value only if the feature has previously been enabled or disabled.
2222

2323
## EXAMPLES
2424

2525
### Example 1
2626
```
27-
PS C:\> {{ Add example code here }}
27+
PS C:\>Get-SPProjectEnterpriseProjectTaskSync -Url http://contoso/sites/PWA
2828
```
2929

30-
{{ Add example description here }}
30+
This example shows the syntax for getting the task sync status for the Project Web App site at http://contoso/sites/PWA.
3131

3232
## PARAMETERS
3333

3434
### -AssignmentCollection
35-
{{Fill AssignmentCollection Description}}
35+
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
36+
37+
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
3638

3739
```yaml
3840
Type: SPAssignmentCollection
@@ -48,7 +50,7 @@ Accept wildcard characters: False
4850
```
4951
5052
### -Url
51-
{{Fill Url Description}}
53+
The URL of the PWA site.
5254
5355
```yaml
5456
Type: Uri

sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectEventServiceSettings.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-SPProjectEventServiceSettings
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Returns the settings for the Microsoft Project Server Events Service. There is currently only one setting which is the port that the service listens on for requests.
1212

1313
## SYNTAX
1414

@@ -17,21 +17,23 @@ Get-SPProjectEventServiceSettings [-AssignmentCollection <SPAssignmentCollection
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
Returns the settings for the Microsoft Project Server Events Service. There is currently only one setting which is the port that the service listens on for requests.
2121

2222
## EXAMPLES
2323

2424
### Example 1
2525
```
26-
PS C:\> {{ Add example code here }}
26+
PS C:\>Get-SPProjectEventServiceSettings
2727
```
2828

29-
{{ Add example description here }}
29+
This example shows what port the service is listening on.
3030

3131
## PARAMETERS
3232

3333
### -AssignmentCollection
34-
{{Fill AssignmentCollection Description}}
34+
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
35+
36+
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
3537

3638
```yaml
3739
Type: SPAssignmentCollection

sharepoint/sharepoint-ps/sharepoint-server/Get-SPProjectIsEmailNotificationEnabled.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file:
3-
applicable: Project Server 2013, Project Server 2016
3+
applicable: Project Server 2016
44
title: Get-SPProjectIsEmailNotificationEnabled
55
schema: 2.0.0
66
---
77

88
# Get-SPProjectIsEmailNotificationEnabled
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Returns the Project Web App site level setting for email notifications. True if notifications is turned on, False otherwise.
1212

1313
## SYNTAX
1414

@@ -18,27 +18,29 @@ Get-SPProjectIsEmailNotificationEnabled [-Url] <Uri> [-AssignmentCollection <SPA
1818
```
1919

2020
## DESCRIPTION
21-
{{Fill in the Description}}
21+
Returns the Project Web App site level setting for email notifications. True if notifications is turned on, False otherwise.
2222

2323
## EXAMPLES
2424

2525
### Example 1
2626
```
27-
PS C:\> {{ Add example code here }}
27+
PS C:\>Get-SPProjectIsEmailNotificationEnabled -Url http://contoso/sites/pwa
2828
```
2929

30-
{{ Add example description here }}
30+
Returns the status of email notifications for the PWA site http://contoso/sites/pwa.
3131

3232
## PARAMETERS
3333

3434
### -AssignmentCollection
35-
{{Fill AssignmentCollection Description}}
35+
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
36+
37+
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
3638

3739
```yaml
3840
Type: SPAssignmentCollection
3941
Parameter Sets: (All)
4042
Aliases:
41-
Applicable: Project Server 2013, Project Server 2016
43+
Applicable: Project Server 2016
4244

4345
Required: False
4446
Position: Named
@@ -48,13 +50,13 @@ Accept wildcard characters: False
4850
```
4951
5052
### -Url
51-
{{Fill Url Description}}
53+
The URL of the Project Web App site.
5254
5355
```yaml
5456
Type: Uri
5557
Parameter Sets: (All)
5658
Aliases:
57-
Applicable: Project Server 2013, Project Server 2016
59+
Applicable: Project Server 2016
5860

5961
Required: True
6062
Position: 0

sharepoint/sharepoint-ps/sharepoint-server/Get-SPSecureStoreApplication.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ For permissions and the most current information about Windows PowerShell for Sh
3737

3838
### ------------------EXAMPLE 1------------------
3939
```
40-
C:\PS>$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication"
40+
PS C:\>$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication"
4141
```
4242

4343
This example gets the Secure Store application for the target application with the name ContosoTargetApplication.
4444

4545
### ------------------EXAMPLE 2------------------
4646
```
47-
C:\PS>Get-SPSecureStoreApplication -ServiceContext http://contoso -All
47+
PS C:\>Get-SPSecureStoreApplication -ServiceContext http://contoso -All
4848
```
4949

50-
This example returns all of the Secure Store applicationshttp://contoso.
50+
This example returns all of the Secure Store applications http://contoso.
5151

5252
## PARAMETERS
5353

@@ -84,13 +84,9 @@ Accept wildcard characters: False
8484
```
8585
8686
### -AssignmentCollection
87-
Manages objects for the purpose of proper disposal.
88-
Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management.
89-
Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory.
90-
When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
87+
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
9188
92-
When the Global parameter is used, all objects are contained in the global store.
93-
If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
89+
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
9490
9591
```yaml
9692
Type: SPAssignmentCollection
@@ -106,7 +102,7 @@ Accept wildcard characters: False
106102
```
107103
108104
### -All
109-
{{Fill All Description}}
105+
Returns all secure store applications for the given Service Context.
110106
111107
```yaml
112108
Type: SwitchParameter

0 commit comments

Comments
 (0)