Skip to content

Latest commit

 

History

History
221 lines (219 loc) · 17 KB

readme.md

File metadata and controls

221 lines (219 loc) · 17 KB

Cmdlet Documentation

Below you can find a list of all the available cmdlets. Many commands provide built-in help and examples. Retrieve the detailed help with

Get-Help Connect-SPOnline -Detailed

##Apps

Cmdlet Description
Uninstall‑SPOAppInstance Removes an app from a site
Get‑SPOAppInstance Returns a SharePoint AddIn Instance
Import‑SPOAppPackage Adds a SharePoint Addin to a site
##Base Cmdlets
Cmdlet Description
:----- :----------
Get‑SPOAuthenticationRealm Gets the authentication realm for the current web
Get‑SPOAzureADManifestKeyCredentials Creates the JSON snippet that is required for the manifest json file for Azure WebApplication / WebAPI apps
Get‑SPOContext Returns a Client Side Object Model context
Set‑SPOContext Sets the Client Context to use by the cmdlets
Get‑SPOHealthScore Retrieves the current health score value of the server
Disconnect‑SPOnline Disconnects the context
Connect‑SPOnline Connects to a SharePoint site and creates an in-memory context
Get‑SPOProperty Will populate properties of an object and optionally, if needed, load the value from the server. If one property is specified its value will be returned to the output.
Execute‑SPOQuery Executes any queued actions / changes on the SharePoint Client Side Object Model Context
Get‑SPOStoredCredential Returns a stored credential from the Windows Credential Manager
Set‑SPOTraceLog Defines if tracing should be turned on. PnP Core, which is the foundation of these cmdlets utilizes the standard Trace functionality of .NET. With this cmdlet you can turn capturing of this trace to a log file on or off.
##Branding
Cmdlet Description
:----- :----------
Remove‑SPOCustomAction Removes a custom action
Get‑SPOCustomAction Returns all or a specific custom action(s)
Add‑SPOCustomAction Adds a custom action to a web
Get‑SPOHomePage Returns the URL to the home page
Set‑SPOHomePage Sets the home page of the current web.
Add‑SPOJavaScriptBlock Adds a link to a JavaScript snippet/block to a web or site collection
Get‑SPOJavaScriptLink Returns all or a specific custom action(s) with location type ScriptLink
Remove‑SPOJavaScriptLink Removes a JavaScript link or block from a web or sitecollection
Add‑SPOJavaScriptLink Adds a link to a JavaScript file to a web or sitecollection
Set‑SPOMasterPage Sets the default master page of the current web.
Set‑SPOMinimalDownloadStrategy Activates or deactivates the minimal downloading strategy.
Add‑SPONavigationNode Adds a menu item to either the quicklaunch or top navigation
Remove‑SPONavigationNode Removes a menu item from either the quicklaunch or top navigation
Convert‑SPOProvisioningTemplate Converts a provisioning template to a web
Apply‑SPOProvisioningTemplate Applies a provisioning template to a web
Get‑SPOProvisioningTemplate Generates a provisioning template from a web
New‑SPOProvisioningTemplateFromFolder Generates a provisioning template from a given folder, including only files that are present in that folder
Get‑SPOTheme Returns the current theme/composed look of the current web.
Set‑SPOTheme Sets the theme of the current web.
##Content Types
Cmdlet Description
:----- :----------
Remove‑SPOContentType Removes a content type
Get‑SPOContentType Retrieves a content type
Add‑SPOContentType Adds a new content type
Remove‑SPOContentTypeFromList Removes a content type from a list
Add‑SPOContentTypeToList Adds a new content type to a list
Set‑SPODefaultContentTypeToList Sets the default content type for a list
Add‑SPOFieldToContentType Adds an existing site column to a content type
##Document Sets
Cmdlet Description
:----- :----------
Remove‑SPOContentTypeFromDocumentSet Removes a content type from a document set
Add‑SPOContentTypeToDocumentSet Adds a content type to a document set
Set‑SPODocumentSetField Sets a site column from the avaiable content types to a document set
Get‑SPODocumentSetTemplate Retrieves a document set template
##Event Receivers
Cmdlet Description
:----- :----------
Add‑SPOEventReceiver Adds a new event receiver
Get‑SPOEventReceiver Returns all or a specific event receiver
Remove‑SPOEventReceiver Removes/unregisters a specific event receiver
##Features
Cmdlet Description
:----- :----------
Get‑SPOFeature Returns all activated or a specific activated feature
Disable‑SPOFeature Disables a feature
Enable‑SPOFeature Enables a feature
##Fields
Cmdlet Description
:----- :----------
Remove‑SPOField Removes a field from a list or a site
Get‑SPOField Returns a field from a list or site
Add‑SPOField Adds a field to a list or as a site column
Add‑SPOFieldFromXml Adds a field to a list or as a site column based upon a CAML/XML field definition
Add‑SPOTaxonomyField Adds a taxonomy field to a list or as a site column.
##Information Management
Cmdlet Description
:----- :----------
Get‑SPOSitePolicy Retrieves all or a specific site policy
Set‑SPOSitePolicy Sets a site policy
##Lists
Cmdlet Description
:----- :----------
Set‑SPODefaultColumnValues Sets default column values for a document library
Remove‑SPOList Deletes a list
Get‑SPOList Returns a List object
New‑SPOList Creates a new list
Set‑SPOList Updates list settings
Add‑SPOListItem Adds an item to a list
Set‑SPOListItem Updates a list item
Get‑SPOListItem Retrieves list items
Set‑SPOListPermission Sets list permissions
Request‑SPOReIndexList Marks the list for full indexing during the next incremental crawl
Add‑SPOView Adds a view to a list
Get‑SPOView Returns one or all views from a list
Remove‑SPOView Deletes a view from a list
##Publishing
Cmdlet Description
:----- :----------
Add‑SPOHtmlPublishingPageLayout Adds a HTML based publishing page layout
Add‑SPOMasterPage Adds a Masterpage
Add‑SPOPublishingPage Adds a publishing page
Add‑SPOPublishingPageLayout Adds a publishing page layout
Remove‑SPOWikiPage Removes a wiki page
Add‑SPOWikiPage Adds a wiki page
Get‑SPOWikiPageContent Gets the contents/source of a wiki page
Set‑SPOWikiPageContent Sets the contents of a wikipage
##Search
Cmdlet Description
:----- :----------
Set‑SPOSearchConfiguration Sets the search configuration
Get‑SPOSearchConfiguration Returns the search configuration
##Sites
Cmdlet Description
:----- :----------
Set‑SPOAppSideLoading Enables the App Side Loading Feature on a site
Get‑SPOAuditing Get the Auditing setting of a site
Set‑SPOAuditing Set Auditing setting for a site
Get‑SPOSite Returns the current site collection from the context.
Uninstall‑SPOSolution Uninstalls a sandboxed solution from a site collection
Install‑SPOSolution Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.
##Taxonomy
Cmdlet Description
:----- :----------
Import‑SPOTaxonomy Imports a taxonomy from either a string array or a file
Export‑SPOTaxonomy Exports a taxonomy to either the output or to a file.
Set‑SPOTaxonomyFieldValue Sets a taxonomy term value in a listitem field
Get‑SPOTaxonomyItem Returns a taxonomy item
Get‑SPOTaxonomySession Returns a taxonomy session
New‑SPOTermGroup Creates a taxonomy term group
Get‑SPOTermGroup Returns a taxonomy term group
Import‑SPOTermGroupFromXml Imports a taxonomy TermGroup from either the input or from an XML file.
Export‑SPOTermGroupToXml Exports a taxonomy TermGroup to either the output or to an XML file.
Import‑SPOTermSet Imports a taxonomy term set from a file in the standard format.
##Tenant Administration
Cmdlet Description
:----- :----------
Set‑SPOTenantSite Office365 only: Uses the tenant API to set site information.
Get‑SPOTenantSite Office365 only: Uses the tenant API to retrieve site information.
Remove‑SPOTenantSite Office365 only: Removes a site collection from the current tenant
New‑SPOTenantSite Creates a new site collection for the current tenant
Get‑SPOTimeZoneId Returns a time zone ID
Get‑SPOWebTemplates Office365 only: Returns the available web templates.
##User and group management
Cmdlet Description
:----- :----------
Remove‑SPOGroup Removes a group.
Set‑SPOGroup Updates a group
New‑SPOGroup Adds a user to the build-in Site User Info List and returns a user object
Get‑SPOGroup Returns a specific group or all groups.
Set‑SPOGroupPermissions Adds and/or removes permissions of a specific SharePoint group
Get‑SPOGroupPermissions Returns the permissions for a specific SharePoint group
New‑SPOUser Adds a user to the build-in Site User Info List and returns a user object
Remove‑SPOUserFromGroup Removes a user from a group
Add‑SPOUserToGroup Adds a user to a group
##User Profiles
Cmdlet Description
:----- :----------
New‑SPOPersonalSite Office365 only: Creates a personal / OneDrive For Business site
Set‑SPOUserProfileProperty Office365 only: Uses the tenant API to retrieve site information. You must connect to the admin website (https://:-admin.sharepoint.com) with Connect-SPOnline in order to use this command.
Get‑SPOUserProfileProperty Office365 only: Uses the tenant API to retrieve site information. You must connect to the admin website (https://:-admin.sharepoint.com) with Connect-SPOnline in order to use this command.
##Utilities
Cmdlet Description
:----- :----------
Send‑SPOMail Sends an email using the Office 365 SMTP Service
##Web Parts
Cmdlet Description
:----- :----------
Remove‑SPOWebPart Removes a webpart from a page
Get‑SPOWebPart Returns a webpart definition object
Get‑SPOWebPartProperty Returns a web part property
Set‑SPOWebPartProperty Sets a web part property
Add‑SPOWebPartToWebPartPage Adds a webpart to a web part page in a specified zone
Add‑SPOWebPartToWikiPage Adds a webpart to a wiki page in a specified table row and column
Get‑SPOWebPartXml Returns the webpart XML of a webpart registered on a site
##Webs
Cmdlet Description
:----- :----------
Remove‑SPOFile Removes a file.
Get‑SPOFile Downloads a file.
Find‑SPOFile Finds a file in the virtual file system of the web.
Add‑SPOFile Uploads a file to Web
Set‑SPOFileCheckedIn Checks in a file
Set‑SPOFileCheckedOut Checks out a file
Add‑SPOFolder Creates a folder within a parent folder
Set‑SPOIndexedProperties Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, e.g. only the properties you define with the cmdlet will be indexed.
Remove‑SPOIndexedProperty Removes a key from propertybag to be indexed by search. The key and it's value retain in the propertybag, however it will not be indexed anymore.
Add‑SPOIndexedProperty Marks the value of the propertybag key to be indexed by search.
Get‑SPOIndexedPropertyKeys Returns the keys of the property bag values that have been marked for indexing by search
Get‑SPOMasterPage Returns the URLS of the default Master Page and the custom Master Page.
Get‑SPOPropertyBag Returns the property bag values.
Remove‑SPOPropertyBagValue Removes a value from the property bag
Set‑SPOPropertyBagValue Sets a property bag value
Request‑SPOReIndexWeb Marks the web for full indexing during the next incremental crawl
Get‑SPOSubWebs Returns the subwebs
Remove‑SPOWeb Removes a subweb in the current web
Get‑SPOWeb Returns the current web object
New‑SPOWeb Creates a new subweb to the current web
Set‑SPOWeb Sets properties on a web
##Workflows
Cmdlet Description
:----- :----------
Add‑SPOWorkflowDefinition Adds a workflow definition
Remove‑SPOWorkflowDefinition Removes a workflow definition
Get‑SPOWorkflowDefinition Returns a workflow definition
Resume‑SPOWorkflowInstance Resumes a previously stopped workflow instance
Stop‑SPOWorkflowInstance Stops a workflow instance
Remove‑SPOWorkflowSubscription Removes a workflow subscription
Add‑SPOWorkflowSubscription Adds a workflow subscription to a list
Get‑SPOWorkflowSubscription Returns a workflow subscriptions from a list