🔍 Code Extractor

A filter class for enumerating SharePoint Online site properties, used to specify criteria when querying site collections in a SharePoint tenant.

Purpose

This class represents a filter object for SharePoint Online Tenant Administration API calls that enumerate site properties. It inherits from ClientValue and provides a structured way to specify filtering criteria such as start index, detail level, personal site inclusion, group ID, and site templates when querying SharePoint site collections. The class is designed to be serialized and sent to SharePoint Online REST APIs for site enumeration operations.

Source Code

class SitePropertiesEnumerableFilter(ClientValue):
    def __init__(
        self,
        _filter,
        start_index=None,
        include_detail=None,
        include_personal_site=None,
        group_id_defined=None,
        template=None,
    ):
        """
        :param str _filter:
        :param str start_index:
        :param bool include_detail:
        :param int include_personal_site:
        :param int group_id_defined:
        :param str template:
        """
        super(SitePropertiesEnumerableFilter, self).__init__()
        self.Filter = _filter
        self.GroupIdDefined = group_id_defined
        self.IncludeDetail = include_detail
        self.IncludePersonalSite = include_personal_site
        self.StartIndex = start_index
        self.Template = template

    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.TenantAdministration.SPOSitePropertiesEnumerableFilter"

Parameters

Parameter Details

_filter: A filter string expression to apply when enumerating sites. This is the primary filter criteria for the query.

start_index: Optional string representing the starting position in the result set for pagination. Used to retrieve results starting from a specific index.

include_detail: Optional boolean flag indicating whether to include detailed information about each site in the results. When True, more comprehensive site properties are returned.

include_personal_site: Optional integer flag (typically 0 or 1) indicating whether to include personal OneDrive sites in the enumeration results.

group_id_defined: Optional integer flag indicating whether to filter sites based on whether they have an associated Office 365 Group ID defined.

template: Optional string specifying a SharePoint site template filter (e.g., 'STS#0' for Team Site, 'SITEPAGEPUBLISHING#0' for Communication Site) to limit results to sites created from specific templates.

Return Value

Instantiation returns a SitePropertiesEnumerableFilter object that can be used as a parameter in SharePoint Online Tenant Administration API calls. The object itself doesn't return values but is serialized for API requests.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.tenant.administration.site_properties_enumerable_filter import SitePropertiesEnumerableFilter

# Create a filter to enumerate all team sites with details
site_filter = SitePropertiesEnumerableFilter(
    _filter='',
    start_index='0',
    include_detail=True,
    include_personal_site=0,
    group_id_defined=None,
    template='STS#0'
)

# The filter would typically be used with a SharePoint tenant context:
# tenant = Tenant(ctx)
# sites = tenant.get_site_properties_from_sharepoint_by_filters(site_filter)
# ctx.execute_query()

# Access the entity type name
print(site_filter.entity_type_name)

Best Practices

• Always provide the _filter parameter even if empty string, as it is required for the API call
• Use start_index for pagination when dealing with large numbers of sites to avoid timeouts
• Set include_detail to False when you only need basic site information to improve performance
• Use template parameter to narrow down results to specific site types for better performance
• The include_personal_site parameter should be 0 (exclude) or 1 (include) as an integer, not a boolean
• This object is typically used as a parameter to tenant administration methods and should not be modified after being passed to an API call
• The entity_type_name property is used internally for serialization and should not be modified

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SiteProperties 71.3% similar

  Represents a SharePoint site collection's properties and provides methods to query and update site-level settings such as sharing capabilities, lock state, and customization permissions.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/sites/properties.py

• class SitePropertiesCollection 70.7% similar

  A collection class for managing SiteProperties resources in SharePoint, providing methods to query and retrieve site information by site ID.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/sites/properties_collection.py

• class SiteStateProperties 67.8% similar

  A data class representing SharePoint site state properties for tenant administration operations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/sites/state_properties.py

• class SiteCreationProperties 67.5% similar

  A data class that encapsulates the properties required to create a new SharePoint site, including URL, owner, title, and template information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/sites/creation_properties.py

• class SiteInfoForSitePicker 63.2% similar

  A data transfer object representing site information for SharePoint site picker operations in Microsoft Online SharePoint Tenant Administration.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/siteinfo_for_site_picker.py