Skip to content

Commit ccf0add

Browse files
authored
Merge pull request MicrosoftDocs#2 from islubin/master
Update from master.
2 parents cb598c9 + 6a6f4af commit ccf0add

File tree

77 files changed

+3217
-1899
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+3217
-1899
lines changed

.openpublishing.publish.config.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
11
{
22
"docsets_to_publish": [
3+
{
4+
"docset_name": "officewebapps-ps",
5+
"build_source_folder": "officewebapps",
6+
"build_output_subfolder": "officewebapps-ps",
7+
"locale": "en-us",
8+
"monikers": [],
9+
"moniker_ranges": [],
10+
"open_to_public_contributors": true,
11+
"type_mapping": {
12+
"Conceptual": "Content",
13+
"ManagedReference": "Content",
14+
"RestApi": "Content",
15+
"AzurePsModulePage": "Content"
16+
},
17+
"build_entry_point": "docs",
18+
"template_folder": "_themes",
19+
"version": 0,
20+
"customized_template_paths": [
21+
"_dependentPackages/azurecli.plugins/azurecli"
22+
],
23+
"customized_tasks": {
24+
"docset_prebuild": [
25+
"_dependentPackages/CommonPlugins/tools/PowerShellReference.ps1"
26+
]
27+
},
28+
"monikerPath": [
29+
"mapping/monikerMapping.json"
30+
]
31+
},
332
{
433
"docset_name": "sharepoint-ps",
534
"build_source_folder": "sharepoint",
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#SharePoint Online Cmdlets
2+
3+
This page contains a listing of SharePoint Online cmdlets.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#SharePoint Patterns and Practices (PnP) Cmdlets
2+
3+
This page contains a listing of SharePoint Pnp (developer) cmdlets.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#SharePoint Server Cmdlets
2+
3+
This page contains a listing of SharePoint Server (on prem) cmdlets.

sharepoint/docs-conceptual/toc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,9 @@
33
items:
44
- name: Introduction
55
href: intro.md
6+
- name: SharePoint Online Cmdlets
7+
href: sharepoint-online-cmdlets.md
8+
- name: SharePoint Server Cmdlets
9+
href: sharepoint-server-cmdlets.md
10+
- name: SharePoint PnP Cmdlets
11+
href: sharepoint-pnp-cmdlets.md

sharepoint/sharepoint-ps/sharepoint/Add-DatabaseToAvailabilityGroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Add-DatabaseToAvailabilityGroup
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Adds an availability group
1111

1212
## SYNTAX
1313

sharepoint/sharepoint-ps/sharepoint/Add-SPEduClassMember.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Add-SPEduClassMember
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Not in use
1111

1212
## SYNTAX
1313

@@ -17,21 +17,20 @@ Add-SPEduClassMember [-AssignmentCollection <SPAssignmentCollection>] -ClassId <
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
Not in use
2121

2222
## EXAMPLES
2323

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

29-
{{ Add example description here }}
3029

3130
## PARAMETERS
3231

3332
### -AssignmentCollection
34-
{{Fill AssignmentCollection Description}}
33+
Not in use
3534

3635
```yaml
3736
Type: SPAssignmentCollection
@@ -47,7 +46,7 @@ Accept wildcard characters: False
4746
```
4847
4948
### -ClassId
50-
{{Fill ClassId Description}}
49+
Not in use
5150
5251
```yaml
5352
Type: String
@@ -63,7 +62,7 @@ Accept wildcard characters: False
6362
```
6463
6564
### -Role
66-
{{Fill Role Description}}
65+
Not in use
6766
6867
```yaml
6968
Type: String
@@ -79,7 +78,7 @@ Accept wildcard characters: False
7978
```
8079
8180
### -Site
82-
{{Fill Site Description}}
81+
Not in use
8382
8483
```yaml
8584
Type: SPSitePipeBind
@@ -95,7 +94,7 @@ Accept wildcard characters: False
9594
```
9695
9796
### -UserAlias
98-
{{Fill UserAlias Description}}
97+
Not in use
9998
10099
```yaml
101100
Type: String

sharepoint/sharepoint-ps/sharepoint/Add-SPEduUser.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Add-SPEduUser
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Do not use
1111

1212
## SYNTAX
1313

@@ -17,21 +17,21 @@ Add-SPEduUser [-AssignmentCollection <SPAssignmentCollection>] [-FirstName <Stri
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
Do not use
2121

2222
## EXAMPLES
2323

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

29-
{{ Add example description here }}
29+
3030

3131
## PARAMETERS
3232

3333
### -AssignmentCollection
34-
{{Fill AssignmentCollection Description}}
34+
Do not use
3535

3636
```yaml
3737
Type: SPAssignmentCollection
@@ -47,7 +47,7 @@ Accept wildcard characters: False
4747
```
4848
4949
### -FirstName
50-
{{Fill FirstName Description}}
50+
Do not use
5151
5252
```yaml
5353
Type: String
@@ -63,7 +63,7 @@ Accept wildcard characters: False
6363
```
6464
6565
### -LastName
66-
{{Fill LastName Description}}
66+
Do not use
6767
6868
```yaml
6969
Type: String
@@ -79,7 +79,7 @@ Accept wildcard characters: False
7979
```
8080
8181
### -Role
82-
{{Fill Role Description}}
82+
Do not use
8383
8484
```yaml
8585
Type: String
@@ -95,7 +95,7 @@ Accept wildcard characters: False
9595
```
9696
9797
### -Site
98-
{{Fill Site Description}}
98+
Do not use
9999
100100
```yaml
101101
Type: SPSitePipeBind
@@ -111,7 +111,7 @@ Accept wildcard characters: False
111111
```
112112
113113
### -UserAlias
114-
{{Fill UserAlias Description}}
114+
Do not use
115115
116116
```yaml
117117
Type: String
@@ -127,7 +127,7 @@ Accept wildcard characters: False
127127
```
128128
129129
### -UserEmail
130-
{{Fill UserEmail Description}}
130+
Do not use
131131
132132
```yaml
133133
Type: String

sharepoint/sharepoint-ps/sharepoint/Add-SPOTenantCdnOrigin.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Add-SPOTenantCdnOrigin
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Configures a new origin to public or private content delivery network (CDN).
1111

1212
## SYNTAX
1313

@@ -17,21 +17,33 @@ Add-SPOTenantCdnOrigin -CdnType <SPOTenantCdnType> [-Confirm] -OriginUrl <String
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
Configures a new origin to public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library, and requests that content in that library should be retrievable by using a CDN.
21+
22+
You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet.
2123

2224
## EXAMPLES
2325

2426
### Example 1
2527
```
26-
PS C:\> {{ Add example code here }}
28+
--------EXAMPLE 1--------
29+
30+
Add-SPOTenantCdnOrigin -CdnType public -OriginUrl */subfolder
31+
32+
This example configures a public CDN on a tenant level.
33+
34+
--------EXAMPLE 2--------
35+
36+
Add-SPOTenantCdnOrigin -CdnType public -OriginUrl */subfolder
37+
38+
This example configures a public CDN on a site level.
2739
```
2840

29-
{{ Add example description here }}
41+
3042

3143
## PARAMETERS
3244

3345
### -CdnType
34-
{{Fill CdnType Description}}
46+
Specifies the CDN type. The valid values are: public or private.
3547

3648
```yaml
3749
Type: SPOTenantCdnType
@@ -55,7 +67,6 @@ Type: SwitchParameter
5567
Parameter Sets: (All)
5668
Aliases: cf
5769
Applicable: SharePoint Online
58-
5970
Required: False
6071
Position: Named
6172
Default value: None
@@ -64,7 +75,12 @@ Accept wildcard characters: False
6475
```
6576
6677
### -OriginUrl
67-
{{Fill OriginUrl Description}}
78+
Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask.
79+
80+
Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library.
81+
82+
83+
6884
6985
```yaml
7086
Type: String

sharepoint/sharepoint-ps/sharepoint/Add-SPServerScaleOutDatabase.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ schema: 2.0.0
88

99
## SYNOPSIS
1010

11-
Applies to:
12-
11+
Adds an existing scale-out content database to the specified service application.
1312

1413

1514
## SYNTAX
@@ -214,7 +213,7 @@ Accept wildcard characters: False
214213
```
215214

216215
### -DeferUpgradeActions
217-
{{Fill DeferUpgradeActions Description}}
216+
Specifies whether upgrade actions are deferred duringi an Upgrade process.
218217

219218
```yaml
220219
Type: SwitchParameter

sharepoint/sharepoint-ps/sharepoint/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88

99
## SYNOPSIS
1010

11-
Applies to:
11+
Clears all partitions inside the specified deleted subrange.
1212

1313

1414

sharepoint/sharepoint-ps/sharepoint/Clear-SPServerScaleOutDatabaseTenantData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88

99
## SYNOPSIS
1010

11-
Applies to:
11+
Removes all data related to the specified site subscription.
1212

1313

1414

sharepoint/sharepoint-ps/sharepoint/Disconnect-SPOService.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ For permissions and the most current information about Windows PowerShell for Sh
3232

3333
### ------------ Example 1 --------------------
3434
```
35-
{example code}
35+
Disconnect-SPOService
3636
```
37-
{example description}
37+
This example disconnects the service for the tenant.
3838

3939
## PARAMETERS
4040

sharepoint/sharepoint-ps/sharepoint/Export-SPServerScaleOutDatabaseTenantData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88

99
## SYNOPSIS
1010

11-
Applies to:
11+
Exports the data of the specified subscription.
1212

1313

1414

sharepoint/sharepoint-ps/sharepoint/Get-AvailabilityGroupStatus.md

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

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Returns one or more objects representing the availability groups known to the SharePoint farm.
1111

1212
## SYNTAX
1313

@@ -23,15 +23,18 @@ Get-AvailabilityGroupStatus [-AssignmentCollection <SPAssignmentCollection>] [-I
2323

2424
### Example 1
2525
```
26-
PS C:\> {{ Add example code here }}
26+
Get-AvailabilityGroupStatus -Identity MyAvailabilityGroup
27+
2728
```
2829

29-
{{ Add example description here }}
30+
This example returns an availability group named "MyAvailabilityGroup".
3031

3132
## PARAMETERS
3233

3334
### -AssignmentCollection
34-
{{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+
NOTE: 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.
3538

3639
```yaml
3740
Type: SPAssignmentCollection
@@ -47,7 +50,7 @@ Accept wildcard characters: False
4750
```
4851
4952
### -Identity
50-
{{Fill Identity Description}}
53+
Finds the availability group whose name property matches this string. Otherwise, returns all availability groups.
5154
5255
```yaml
5356
Type: String

0 commit comments

Comments
 (0)