Tenant.GetSitePropertiesByFilter method

Returns properties for all sites in the tenant that match the filter expression.

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

Syntax

'Declaration
Public Overridable Function GetSitePropertiesByFilter ( _
    filter As String, _
    startIndex As Integer, _
    includeDetail As Boolean _
) As SPOSitePropertiesEnumerable
'Usage
Dim instance As Tenant
Dim filter As String
Dim startIndex As Integer
Dim includeDetail As Boolean
Dim returnValue As SPOSitePropertiesEnumerable

returnValue = instance.GetSitePropertiesByFilter(filter, _
    startIndex, includeDetail)

public virtual SPOSitePropertiesEnumerable GetSitePropertiesByFilter(
    string filter,
    int startIndex,
    bool includeDetail
)

Parameters

• filter
  Type: System.String

  A string that represents the filter expression.

• startIndex
  Type: System.Int32

  An integer that represents the start index of the list of deleted sites.

• includeDetail
  Type: System.Boolean

  A Boolean value that indicates whether to include all of the SPSite properties.

Return value

Type: Microsoft.Online.SharePoint.TenantAdministration.SPOSitePropertiesEnumerable
SPOSitePropertiesEnumerable

Remarks

If the filter is null or an empty string, then properties for all of the sites are returned.

See also

Reference

Tenant class

Tenant members

Microsoft.Online.SharePoint.TenantAdministration namespace