SharePoint Online - Working with Lists Using PowerShell

In this article, we will discuss SharePoint List operations using PowerShell for SharePoint Online.

To start with this demo, I have created a sample SharePoint Online Site that I will use to perform SharePoint operations in this and a few of the upcoming articles in this series.

In case you are not aware of how to start with PowerShell development for SharePoint Online, I would  recommend you to first go through one of my previous articles. This article will help you to set up the development environment and get you started.

• SharePoint Online: How To Install SharePoint Online Management Shell

Provide SharePoint Online Site credential when it is asked for.

Operation: How To Get Lists Collection

 

In Step 1, we will initialize the Web Object using SharePoint Client Context.

In Step 2, we initialize the SharePoint Lists Collection.

In Step 3, we call the “Load” function to retrieve SharePoint List Collection properties from the Server.

In Step 4, we call “ExecuteQuery” method to send the request to SharePoint Server.

In Step 5, we iterate the lists collection returned back from the server and display required list properties as output.

In Step 6, we call the function that we have explained in Step 1-5.

And here is the output for this operation.

Operation: How To Add New List

 

In Step 1, we will initialize “ListCreationInformation” object which allows specifying the metadata details for this new list.

In Step 2, we will specify a Title for the new list.

In Step 3, we will specify Description for the new list.

In Step 4, we will specify List Template for the new list. In this example, we will use Custom List Template.

In Step 5, we will call the “Add” method of “Lists” collection for SharePoint Web.

In Step 6, we will call the “Load” method, to retrieve the properties of the list object from Server.

In Step 7, we call “ExecuteQuery” method to send the request to SharePoint Server.

In Step 8, we call a function that we have explained in Step 1-7.

On successful execution of Step 1-7, we will get a list added to SharePoint and Internal ID of the list as Output.

And here is the output for this operation.

We can also look at the SharePoint Site to ensure that a new list has been added.

 

 

Operation: How To Update Existing List

 

In Step 1, we will initialize “List” object which allows modifying the metadata details for this existing list.

In Step 2, we will update the description of the existing list.

In Step 3, we will call “Update” function of list object and then call “Load” method, to retrieve the properties of list object from Server.

In Step 4, we call “ExecuteQuery” method to send the request to the SharePoint Server.

In Step 5, we will retrieve the list description to ensure that it is updated successfully.

In Step 6, we call a function that we have explained in Step 1-6.

And here is the output for this operation.

We can also look at the SharePoint Site to ensure that the list description has been updated.

 

Operation: How To Delete Existing List

 

In Step 1, we will initialize “List” object by calling a method “GetByTitle” on the Web Object.

In Step 2, we will call “DeleteObject” method on List Object that will delete the reference of the respective list from lists collection.

In Step 3, we call “ExecuteQuery” method to send the request to the SharePoint Server.

In Step 4, we will display the success message to inform the successful deletion of the list.

In Step 5, we call a function that we have explained in Step 1-4

And here is the output for this operation.

We can also look at the  SharePoint Site to ensure that the list has been deleted successfully from SharePoint.

 

Code Snippet

function GetAllLists() {
    $web = $clientContext.Web;
    $listColl = $web.Lists;
    $clientContext.Load($listColl);
    $clientContext.ExecuteQuery();
    foreach($list in $listColl) {
   #Display the list name and ID
        write - host - ForegroundColor Green "List Name: "
        $list.Title " ID: "
        $list.Id
    }
}

function CreateList() {
    $creationInfo = New - Object Microsoft.SharePoint.Client.ListCreationInformation;
    $creationInfo.Title = "Products";
    $creationInfo.Description = "Products list created using Powershell";
    $creationInfo.TemplateType = [int][Microsoft.SharePoint.Client.ListTemplateType]::GenericList
    $newList = $clientContext.Web.Lists.Add($creationInfo);
    $clientContext.Load($newList);
    $clientContext.ExecuteQuery();
    write - host - ForegroundColor Green "List Name: "
    $newList.Title " ID: "
    $newList.Id
}

function DeleteList() {
    $list = $clientContext.Web.Lists.GetByTitle("Products");
    $list.DeleteObject();
    $clientContext.ExecuteQuery();
    write - host - ForegroundColor Green "List Deleted successfully"
}

function UpdateList() {
    $list = $clientContext.Web.Lists.GetByTitle("Products");
    $list.Description = "Products description updated using Powershell";
    $list.Update();
    $clientContext.Load($list);
    $clientContext.ExecuteQuery();
    Write - Host - ForegroundColor Green "List Name: "
    $list.Title " Description: "
    $list.Description
}

That is all for this demo.

Stay tuned for the upcoming articles in this series.

I hope you find it helpful.