Tenant.RemoveSite method

Deletes the site with the specified URL.

Namespace:  Microsoft.Online.SharePoint.TenantAdministration
Assembly:  Microsoft.Online.SharePoint.Client.Tenant (in Microsoft.Online.SharePoint.Client.Tenant.dll)

Syntax

'Declaration
Public Overridable Function RemoveSite ( _
    siteUrl As String _
) As SpoOperation
'Usage
Dim instance As Tenant
Dim siteUrl As String
Dim returnValue As SpoOperation

returnValue = instance.RemoveSite(siteUrl)

public virtual SpoOperation RemoveSite(
    string siteUrl
)

Parameters

• siteUrl
  Type: System.String

  A string that represents the site to delete.

Return value

Type: Microsoft.Online.SharePoint.TenantAdministration.SpoOperation
SpoOperation

Remarks

This sample shows how to use the RemoveSite method.

/// <summary>
/// Delete a site.
/// </summary>
/// <param name="targetUrl">site url</param>
internal void DeleteSite(String targetUrl)
{
    var ctx = new ClientRuntimeContext(targetUrl);
    var tenant = new Tenant(ctx);
    var spoOperation = tenant.RemoveSite(targetUrl);
    ctx.Load(spoOperation);
    ctx.ExecuteQuery();
            
    Console.WriteLine("Time: " + DateTime.Now);
    while (!spoOperation.IsComplete)
    {
        Thread.Sleep(2000);
        ctx.Load(spoOperation);
        ctx.ExecuteQuery();
        Console.WriteLine("Site creation status: " + (spoOperation.IsComplete ? "waiting" : "complete"));
    }

    Console.WriteLine("Time: " + DateTime.Now);
    Console.WriteLine("Verify that site no longer show up in getSiteProperties");
    try
    {
        SiteProperties site = tenant.GetSitePropertiesByUrl(targetUrl, false);
        ctx.Load(site);
        ctx.ExecuteQuery();
        Console.WriteLine("Site is not deleted");
    }
    catch (ServerException e)
    {
        Console.WriteLine("Cannot find the active site: " + e.Message);
    }
}

See also

Reference

Tenant class

Tenant members

Microsoft.Online.SharePoint.TenantAdministration namespace