Skip to content
This repository was archived by the owner on Feb 20, 2022. It is now read-only.

Commit c2f26e4

Browse files
committed
Merge branch 'master' into chrisda
2 parents 3b1a700 + 336e7bc commit c2f26e4

File tree

11 files changed

+290
-293
lines changed

11 files changed

+290
-293
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Short URL: aka.ms/office-powershell
22

3-
# Overview
3+
## Overview
44
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 also 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.
55
![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png)
66

7-
# Learn How To Contribute
7+
## Learn How To Contribute
88
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
99
When you contribute your work will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
1010

1111
> 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.
1212
13-
# Quick Start
13+
## Quick Start
1414

15-
## Contribute using the GitHub website
15+
### Contribute using the GitHub website
1616

1717
[![Image of Quick Start video](images/edit_video_capture.jpg)](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)
1818

@@ -42,9 +42,9 @@ Looking for more in-depth content? Check out the following:
4242
* [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md)
4343
* [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md)
4444

45-
# Microsoft Open Source Code of Conduct
45+
## Microsoft Open Source Code of Conduct
4646

47-
## Contributing
47+
### Contributing
4848

4949
This project welcomes contributions and suggestions. Most contributions require you to agree to a
5050
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Overview ##
1+
# Overview
22

33
Microsoft PowerShell is a command-line shell and scripting language that provides an administrator full access to applicable application programming interfaces (APIs). Administrators can interact directly with SharePoint Server to manipulate web applications, site collections, sites, lists and much more. In addition, an administrator can script cmdlets (pronounced "command-lets").
44

@@ -12,38 +12,37 @@ For a list of SharePoint Online cmdlets, see [SharePoint Online cmdlets](sharepo
1212

1313
For a list of the SharePoint PnP cmdlets, see [SharePoint PnP cmdlets](sharepoint-pnp/sharepoint-pnp-cmdlets.md)
1414

15-
#### SharePoint Online ####
15+
## SharePoint Online
1616

1717
Verify that you have the following administrative permissions:
1818

19-
* You must be assigned the global administrator role on the SharePoint Online site on which you are running the PowerShell cmdlet.
20-
For more information, see [Default administrative roles and user groups](https://support.office.com/en-us/article/Default-SharePoint-Groups-13BB2B6B-DD8C-447E-B71B-0E4BB9EFE1D3?ui=en-US&rs=en-US&ad=US).
19+
* You must be assigned the global administrator role on the SharePoint Online site on which you are running the PowerShell cmdlet.
20+
 For more information, see [Default administrative roles and user groups](https://support.office.com/en-us/article/Default-SharePoint-Groups-13BB2B6B-DD8C-447E-B71B-0E4BB9EFE1D3?ui=en-US&rs=en-US&ad=US).
2121

2222
**IMPORTANT:** You can use a specific group of PowerShell with SharePoint Online. For more information, see [Office 365 PowerShell for SharePoint Online](https://technet.microsoft.com/en-us/library/fp161362(v=office.16).aspx).
2323

24-
## Learning PowerShell ##
24+
## Learning PowerShell
2525

2626
There are several PowerShell learning resources for SharePoint IT professionals.
2727

28-
#### TechNet Scripting Center ####
28+
### TechNet Scripting Center
2929

3030
The TechNet Scripting Center includes many resources to help you learn the basics about PowerShell. It also contains script repositories with samples of scripts that are typically used with various Microsoft products. The following table shows the main learning resources.
3131

3232
|**Page**|**Description**|
3333
|------------------|------------------|
34-
|[Windows PowerShell Documentation on TechNet ](https://docs.microsoft.com/powershell/scripting/powershell-scripting?view=powershell-5.1)|This section of the TechNet Library contains web copies of the core PowerShell Get-Help topics. The section also has web copies of the PowerShell Getting Started document, the PowerShell.exe help, and a PowerShell primer.|
35-
|[Scripting With Windows PowerShell ](https://technet.microsoft.com/en-us/scriptcenter/dd742419.aspx)| The home page for PowerShell scripting learning resources.|
36-
|[Windows PowerShell Owner's Manual ](https://technet.microsoft.com/en-us/library/ee221100.aspx)|Web-based guide for getting started with PowerShell.|
37-
|[Windows PowerShell Quick Reference ](https://www.microsoft.com/en-us/download/details.aspx?id=30002)|Downloadable copy of the Quick Reference document that is installed with PowerShell.|
34+
|[Windows PowerShell Documentation on TechNet](https://docs.microsoft.com/en-us/powershell/scripting/powershell-scripting?view=powershell-5.1)|This section of the TechNet Library contains web copies of the core PowerShell Get-Help topics. The section also has web copies of the PowerShell Getting Started document, the PowerShell.exe help, and a PowerShell primer.|
35+
|[Scripting With Windows PowerShell](https://technet.microsoft.com/en-us/scriptcenter/dd742419.aspx)| The home page for PowerShell scripting learning resources.|
36+
|[Windows PowerShell Owner's Manual](https://technet.microsoft.com/en-us/library/ee221100.aspx)|Web-based guide for getting started with PowerShell.|
37+
|[Windows PowerShell Quick Reference](https://www.microsoft.com/en-us/download/details.aspx?id=30002)|Downloadable copy of the Quick Reference document that is installed with PowerShell.|
3838

3939
As you read these resources, consider that the following concepts and cmdlets are useful ones to learn before you use PowerShell for SharePoint Server:
4040

4141
* [Get-Command](https://go.microsoft.com/fwlink/p/?LinkId=171069)
4242
* [Get-Member](https://go.microsoft.com/fwlink/p/?LinkId=171070)
4343
* [Get-Help](https://go.microsoft.com/fwlink/p/?LinkId=171068)
4444
* [Aliasing](https://go.microsoft.com/fwlink/p/?LinkId=113207)
45-
* [Piping and the Pipeline in Windows PowerShell ](https://technet.microsoft.com/en-us/library/ee176927.aspx)
46-
* [Cmdlet Parameter Sets ](https://msdn.microsoft.com/library/dd878348(VS.85).aspx)
47-
* [Foreach-Object ](https://technet.microsoft.com/en-us/library/ee176828.aspx)
45+
* [Piping and the Pipeline in Windows PowerShell](https://technet.microsoft.com/en-us/library/ee176927.aspx)
46+
* [Cmdlet Parameter Sets](https://msdn.microsoft.com/library/dd878348(VS.85).aspx)
47+
* [Foreach-Object](https://technet.microsoft.com/en-us/library/ee176828.aspx)
4848
* [Where-Object](https://technet.microsoft.com/en-us/library/ee177028.aspx)
49-

sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# What is the SharePoint Online Management Shell? #
1+
# What is the SharePoint Online Management Shell?
22

33
The SharePoint Online Management Shell is a Windows PowerShell module that you can use to manage SharePoint Online users, sites, and site collections. Command-line operations in Windows PowerShell are composed of a series of commands. Each command uses a cmdlet and a set of settings known as parameters. For example, you use the **New-SPOSite** cmdlet for a command that creates a new SharePoint Online site collection with a specified title, URL, owner, storage quota, and template (the parameters).
44

55
SharePoint Online PowerShell commands can be very efficient for batch operations — for example, creating a dozen new site collections or adding hundreds of new SharePoint Online users to a site. For more information, see [Why you need to use Office 365 PowerShell](https://technet.microsoft.com/library/dn568034.aspx).
66

7-
#### What is the difference between SharePoint Online PowerShell commands and Office 365 PowerShell commands? ####
7+
## What is the difference between SharePoint Online PowerShell commands and Office 365 PowerShell commands?
88

9-
The major and obvious difference is the nouns they use. Every SharePoint Online cmdlet will start with SPO as its noun. Conversely, Office 365 will start with MSO as it noun.
9+
The major and obvious difference is the nouns they use. Every SharePoint Online cmdlet will start with SPO as its noun. Conversely, Office 365 will start with MSO as it noun.
1010

1111
The set of SharePoint Online Management Shell commands differs from the set of Office 365 for professionals and small businesses PowerShell commands. SharePoint Online Management Shell commands manage SharePoint Online users and site collections, whereas Office 365 commands manage Office 365-level tasks such as users, licenses, organization information, and services. They both manage users and groups. However, Office 365 PowerShell commands manage users and groups for all of the Office 365 services. The SharePoint Online commands manage users and groups only for SharePoint Online.
1212

13-
#### Should I use the SharePoint Online Admin Center or SharePoint Online PowerShell commands? ####
13+
## Should I use the SharePoint Online Admin Center or SharePoint Online PowerShell commands? ####
1414

15-
If you are new to Office 365 and SharePoint Online and you have not done much managing of SharePoint sites or users, the SharePoint Online Administration Center is a good place to start.
15+
If you are new to Office 365 and SharePoint Online and you have not done much managing of SharePoint sites or users, the SharePoint Online Administration Center is a good place to start.
1616

1717
After you get familiar with SharePoint Online sites and users, try using SharePoint Online commands, especially when you want to manage lots of users, sites, or site collections.
1818

19-
# How do I get permissions and set up the environment? #
19+
## How do I get permissions and set up the environment?
2020

2121
To use SharePoint Online PowerShell commands, you must be a SharePoint Online global administrator.
2222

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ ms.reviewer:
1111
# Get-SPOGeoAdministrator
1212

1313
## SYNOPSIS
14+
1415
This cmdlet returns the SharePoint Online user or security group accounts with global administrative privileges in the current Multi-Geographics tenant.
1516

1617
## SYNTAX
@@ -32,25 +33,24 @@ You must be a SharePoint Online or global administrator and you must have a the
3233

3334
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832).
3435

35-
3636
## EXAMPLES
3737

38-
### Example 1
38+
### Example 1
39+
3940
```powershell
40-
Get-SPOGeoAdministrator
41+
Get-SPOGeoAdministrator
4142
```
4243
This cmdlet will output a SharePoint Online user or security group that is Multi-Geographic administrators on the current multi-geo tenant.
4344

4445
## PARAMETERS
4546

4647
### CommonParameters
47-
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).
48-
4948

49+
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).
5050

5151
## RELATED LINKS
5252

53-
[Add or remove a geo administrator ](https://docs.microsoft.com/Office365/Enterprise/add-a-sharepoint-geo-admin)
53+
[Add or remove a geo administrator](https://docs.microsoft.com/Office365/Enterprise/add-a-sharepoint-geo-admin)
5454

5555
[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps)
5656

@@ -59,5 +59,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5959
[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md)
6060

6161
[Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md)
62-
63-

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.author: antonla
1010
# Set-SPOOrgNewsSite
1111

1212
## SYNOPSIS
13-
Marks a site as one of multile possible tenant's organizational news sites. Requires Tenant administrator permissions.
13+
Marks a site as one of multiple possible tenant's organizational news sites. Requires Tenant administrator permissions.
1414

1515
## SYNTAX
1616

0 commit comments

Comments
 (0)