Search Results for

    Show / Hide Table of Contents

    Interface ISiteCollectionProperties

    Properties of a site collection

    Namespace: PnP.Core.Admin.Model.SharePoint
    Assembly: PnP.Core.Admin.dll
    Syntax
    public interface ISiteCollectionProperties

    Properties

    AllowDownloadingNonWebViewableFiles

    Indicates whether end users can download non-viewable files (e.g. zip) from browser. By default, this would be set to true if setting ConditionalAccessPolicy to AllowLimitedAccess. This can be set to false to block automatic download of files that can't be vieweed in the browser

    Declaration
    bool AllowDownloadingNonWebViewableFiles { get; set; }
    Property Value
    System.Boolean

    AllowEditing

    Indicates whether WAC files should be open in Edit mode. By default, this would be set to true if setting ConditionalAccessPolicy to AllowLimitedAccess. This can be set to false to enable view only mode in WAC.

    Declaration
    bool AllowEditing { get; set; }
    Property Value
    System.Boolean

    AllowSelfServiceUpgrade

    Flag that indicates is a site supports self-service upgrade

    Declaration
    bool AllowSelfServiceUpgrade { get; set; }
    Property Value
    System.Boolean

    AnonymousLinkExpirationInDays

    Anonymous link expiration in days

    Declaration
    int AnonymousLinkExpirationInDays { get; set; }
    Property Value
    System.Int32

    AuthContextStrength

    Gets or sets the authentication context strength for this site for all the webs

    Declaration
    string AuthContextStrength { get; set; }
    Property Value
    System.String

    AuthenticationContextName

    Gets or sets the authentication context for this site for all the webs

    Declaration
    string AuthenticationContextName { get; set; }
    Property Value
    System.String

    BlockDownloadLinksFileType

    Specifies the types of files that can be displayed when the block download links feature is being used

    Declaration
    BlockDownloadLinksFileTypes BlockDownloadLinksFileType { get; set; }
    Property Value
    BlockDownloadLinksFileTypes

    BlockDownloadPolicy

    Gets or sets the Block download policy flag

    Declaration
    bool BlockDownloadPolicy { get; set; }
    Property Value
    System.Boolean

    ClearRestrictedAccessControl

    Clears the Restricted access control groups

    Declaration
    bool ClearRestrictedAccessControl { get; set; }
    Property Value
    System.Boolean

    CommentsOnSitePagesDisabled

    Whether comments on site pages are disabled or not

    Declaration
    bool CommentsOnSitePagesDisabled { get; set; }
    Property Value
    System.Boolean

    CompatibilityLevel

    The compatibility leve of this site

    Declaration
    int CompatibilityLevel { get; }
    Property Value
    System.Int32

    ConditionalAccessPolicy

    Flag that controls access from devices that aren't compliant or joined to a domain to have limited access (web-only, without the Download, Print, and Sync commands)

    Declaration
    SPOConditionalAccessPolicyType ConditionalAccessPolicy { get; set; }
    Property Value
    SPOConditionalAccessPolicyType

    DefaultLinkPermission

    The default link permission for this site

    Declaration
    SharingPermissionType DefaultLinkPermission { get; set; }
    Property Value
    SharingPermissionType

    DefaultLinkToExistingAccess

    The default link to existing access for this site

    Declaration
    bool DefaultLinkToExistingAccess { get; set; }
    Property Value
    System.Boolean

    DefaultLinkToExistingAccessReset

    This is to reset default link to existing access for this site. After resetting, the value will be default (false) or respect the higher level value

    Declaration
    bool DefaultLinkToExistingAccessReset { get; set; }
    Property Value
    System.Boolean

    DefaultShareLinkRole

    Default share link role

    Declaration
    Role DefaultShareLinkRole { get; set; }
    Property Value
    Role

    DefaultShareLinkScope

    Default share link scope

    Declaration
    SharingScope DefaultShareLinkScope { get; set; }
    Property Value
    SharingScope

    DefaultSharingLinkType

    The default link type for this site

    Declaration
    SharingLinkType DefaultSharingLinkType { get; set; }
    Property Value
    SharingLinkType

    DenyAddAndCustomizePages

    Determines whether the site has AddAndCustomizePages denied

    Declaration
    DenyAddAndCustomizePagesStatus DenyAddAndCustomizePages { get; set; }
    Property Value
    DenyAddAndCustomizePagesStatus

    Description

    Site's description

    Declaration
    string Description { get; }
    Property Value
    System.String

    DisableAppViews

    Indicates whether app views are disabled in all the webs of this site

    Declaration
    AppViewsPolicy DisableAppViews { get; set; }
    Property Value
    AppViewsPolicy

    DisableCompanyWideSharingLinks

    Indicates whether company wide sharing links are disabled in all the webs of this site

    Declaration
    CompanyWideSharingLinksPolicy DisableCompanyWideSharingLinks { get; set; }
    Property Value
    CompanyWideSharingLinksPolicy

    DisableFlows

    Indicates whether flows are disabled in all the webs of this site

    Declaration
    FlowsPolicy DisableFlows { get; set; }
    Property Value
    FlowsPolicy

    ExcludeBlockDownloadPolicySiteOwners

    Gets or sets the exclude site owners flag for Block download policy

    Declaration
    bool ExcludeBlockDownloadPolicySiteOwners { get; set; }
    Property Value
    System.Boolean

    ExternalUserExpirationInDays

    External user expiration in days

    Declaration
    int ExternalUserExpirationInDays { get; set; }
    Property Value
    System.Int32

    GroupId

    The GroupId of the site

    Declaration
    Guid GroupId { get; }
    Property Value
    Guid

    GroupOwnerLoginName

    The login name of the group owner

    Declaration
    string GroupOwnerLoginName { get; }
    Property Value
    System.String

    HasHolds

    Flag that indicates a site has Holds

    Declaration
    bool HasHolds { get; }
    Property Value
    System.Boolean

    HubSiteId

    The HubSiteId of the HubSite this site is associated with

    Declaration
    Guid HubSiteId { get; }
    Property Value
    Guid

    IBMode

    get or Set IBMode (Information Barrier Mode)

    Declaration
    string IBMode { get; set; }
    Property Value
    System.String

    IBSegments

    Gets or sets the IB (Information Barrier Mode) segment GUIDs

    Declaration
    Guid[] IBSegments { get; set; }
    Property Value
    Guid[]

    IBSegmentsToAdd

    Gets or sets the IB (Information Barrier Mode) segments to add

    Declaration
    Guid[] IBSegmentsToAdd { get; set; }
    Property Value
    Guid[]

    IBSegmentsToRemove

    Gets or sets the IB (Information Barrier Mode) segments to remove

    Declaration
    Guid[] IBSegmentsToRemove { get; set; }
    Property Value
    Guid[]

    IsGroupOwnerSiteAdmin

    Whether group owner is site admin

    Declaration
    bool IsGroupOwnerSiteAdmin { get; }
    Property Value
    System.Boolean

    IsHubSite

    Whether or not this site is a HubSite

    Declaration
    bool IsHubSite { get; }
    Property Value
    System.Boolean

    IsTeamsChannelConnected

    Gets if the site is connected to a team channel in Microsoft Teams.

    Declaration
    bool IsTeamsChannelConnected { get; }
    Property Value
    System.Boolean

    IsTeamsConnected

    Gets if the site is connected to a team in Microsoft Teams

    Declaration
    bool IsTeamsConnected { get; }
    Property Value
    System.Boolean

    LastContentModifiedDate

    The last time content was modified on the site

    Declaration
    DateTime LastContentModifiedDate { get; }
    Property Value
    DateTime

    Lcid

    The Locale ID of the site

    Declaration
    int Lcid { get; set; }
    Property Value
    System.Int32

    LimitedAccessFileType

    Specifies what files can be viewed when ConditionalAccessPolicy is set to AllowLimitedAccess

    Declaration
    SPOLimitedAccessFileType LimitedAccessFileType { get; set; }
    Property Value
    SPOLimitedAccessFileType

    LockIssue

    A description of the lock issue

    Declaration
    string LockIssue { get; }
    Property Value
    System.String

    LockState

    A string representing the lock state of the site. Valid values are

    • Unlock: the site is not locked, default state
    • NoAccess: the site is locked for all access
    • ReadOnly: the site is set to read only status
    Declaration
    string LockState { get; set; }
    Property Value
    System.String

    MediaTranscription

    Gets or sets the media transcription policy

    Declaration
    MediaTranscriptionPolicyType MediaTranscription { get; set; }
    Property Value
    MediaTranscriptionPolicyType

    OverrideBlockUserInfoVisibility

    Indicates what the state of the browse user info policy in the site

    Declaration
    SiteUserInfoVisibilityPolicyValue OverrideBlockUserInfoVisibility { get; set; }
    Property Value
    SiteUserInfoVisibilityPolicyValue

    OverrideTenantAnonymousLinkExpirationPolicy

    This site overrides the tenant anonymous link expiration policy

    Declaration
    bool OverrideTenantAnonymousLinkExpirationPolicy { get; set; }
    Property Value
    System.Boolean

    OverrideTenantExternalUserExpirationPolicy

    This site overrides the tenant external user expiration policy

    Declaration
    bool OverrideTenantExternalUserExpirationPolicy { get; set; }
    Property Value
    System.Boolean

    Owner

    The decoded login name of the site owner

    Declaration
    string Owner { get; set; }
    Property Value
    System.String

    OwnerEmail

    The email address of the site owner

    Declaration
    string OwnerEmail { get; }
    Property Value
    System.String

    OwnerLoginName

    The encoded login name of the site owner

    Declaration
    string OwnerLoginName { get; }
    Property Value
    System.String

    OwnerName

    The site owner name

    Declaration
    string OwnerName { get; }
    Property Value
    System.String

    PWAEnabled

    Determines whether PWA is enabled for the site

    Declaration
    PWAEnabledStatus PWAEnabled { get; set; }
    Property Value
    PWAEnabledStatus

    ReadOnlyForUnmanagedDevices

    Gets or sets the Read only access for unmanaged devices policy flag

    Declaration
    bool ReadOnlyForUnmanagedDevices { get; set; }
    Property Value
    System.Boolean

    RelatedGroupId

    The GroupId of the group this site is associated with

    Declaration
    Guid RelatedGroupId { get; }
    Property Value
    Guid

    RequestFilesLinkEnabled

    Gets or sets request files link enabled

    Declaration
    bool RequestFilesLinkEnabled { get; set; }
    Property Value
    System.Boolean

    RequestFilesLinkExpirationInDays

    Gets or sets request files link expiration days

    Declaration
    int RequestFilesLinkExpirationInDays { get; set; }
    Property Value
    System.Int32

    RestrictedAccessControl

    Gets or sets the Restricted access control policy flag based on group membership

    Declaration
    bool RestrictedAccessControl { get; set; }
    Property Value
    System.Boolean

    RestrictedAccessControlGroups

    Gets or sets the Restricted Access Control Groups

    Declaration
    IList<Guid> RestrictedAccessControlGroups { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.IList<Guid>

    RestrictedAccessControlGroupsToAdd

    Gets or sets the restricted access control groups to be added

    Declaration
    IList<Guid> RestrictedAccessControlGroupsToAdd { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.IList<Guid>

    RestrictedAccessControlGroupsToRemove

    Gets or sets the restricted access control groups to be removed

    Declaration
    IList<Guid> RestrictedAccessControlGroupsToRemove { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.IList<Guid>

    RestrictedToRegion

    Determines whether the site is resticted to a specific geo location

    Declaration
    RestrictedToRegion RestrictedToRegion { get; set; }
    Property Value
    RestrictedToRegion

    SensitivityLabel

    The Guid of an Information Protection label

    Declaration
    Guid SensitivityLabel { get; set; }
    Property Value
    Guid

    SensitivityLabel2

    The Guid of an Information Protection label

    Declaration
    string SensitivityLabel2 { get; set; }
    Property Value
    System.String

    SetOwnerWithoutUpdatingSecondaryAdmin

    Whether update secondary admin during setting primary admin

    Declaration
    bool SetOwnerWithoutUpdatingSecondaryAdmin { get; set; }
    Property Value
    System.Boolean

    SharingAllowedDomainList

    A list of allowed domain names for this site

    Declaration
    string SharingAllowedDomainList { get; set; }
    Property Value
    System.String

    SharingBlockedDomainList

    A list of blocked domain names for this site

    Declaration
    string SharingBlockedDomainList { get; set; }
    Property Value
    System.String

    SharingCapability

    Specifies what type of external user and guest link sharing is enabled

    Declaration
    SharingCapabilities SharingCapability { get; set; }
    Property Value
    SharingCapabilities

    SharingDomainRestrictionMode

    Indicates what this site's domain restriction mode is

    Declaration
    SharingDomainRestrictionModes SharingDomainRestrictionMode { get; set; }
    Property Value
    SharingDomainRestrictionModes

    SharingLockDownCanBeCleared

    Get whether the sharing lock can be cleared

    Declaration
    bool SharingLockDownCanBeCleared { get; }
    Property Value
    System.Boolean

    SharingLockDownEnabled

    Gets the SharingLockDownEnabled setting

    Declaration
    bool SharingLockDownEnabled { get; }
    Property Value
    System.Boolean

    ShowPeoplePickerSuggestionsForGuestUsers

    Flag that controls allowing members to search guest users in the directory

    Declaration
    bool ShowPeoplePickerSuggestionsForGuestUsers { get; set; }
    Property Value
    System.Boolean

    SiteDefinedSharingCapability

    Specifies what type of external user and guest link sharing is enabled for the site

    Declaration
    SharingCapabilities SiteDefinedSharingCapability { get; }
    Property Value
    SharingCapabilities

    SocialBarOnSitePagesDisabled

    Whether social bar on site pages is enabled or not

    Declaration
    bool SocialBarOnSitePagesDisabled { get; set; }
    Property Value
    System.Boolean

    Status

    The status of the site, possible values are:

    • Active: default status for a site
    • Recycled: the site is the tenant's site collection recyclebin
    Declaration
    string Status { get; }
    Property Value
    System.String

    StorageMaximumLevel

    The Storage Quota

    Declaration
    long StorageMaximumLevel { get; set; }
    Property Value
    System.Int64

    StorageQuotaType

    The storage quota type for the site

    Declaration
    string StorageQuotaType { get; }
    Property Value
    System.String

    StorageUsage

    The current usage of storage for the site

    Declaration
    long StorageUsage { get; }
    Property Value
    System.Int64

    StorageWarningLevel

    The warning level for storage usage

    Declaration
    long StorageWarningLevel { get; set; }
    Property Value
    System.Int64

    TeamsChannelType

    When the site is connected to a team channel in Microsoft Teams, gets the type of channel the site is connected to

    Declaration
    TeamsChannelTypeValue TeamsChannelType { get; }
    Property Value
    TeamsChannelTypeValue

    Template

    The site's web template name

    Declaration
    string Template { get; set; }
    Property Value
    System.String

    TimeZoneId

    The TimeZone

    Declaration
    TimeZone TimeZoneId { get; set; }
    Property Value
    TimeZone

    Title

    The site's title

    Declaration
    string Title { get; set; }
    Property Value
    System.String

    Url

    The Url of the site

    Declaration
    string Url { get; }
    Property Value
    System.String

    WebsCount

    The number of webs in the site

    Declaration
    int WebsCount { get; }
    Property Value
    System.Int32

    Methods

    Update(VanityUrlOptions)

    Updates the properties of this site collection

    Declaration
    void Update(VanityUrlOptions vanityUrlOptions = null)
    Parameters
    VanityUrlOptions vanityUrlOptions

    Optionally specify the custom vanity URI's used by this tenant

    UpdateAsync(VanityUrlOptions)

    Updates the properties of this site collection

    Declaration
    Task UpdateAsync(VanityUrlOptions vanityUrlOptions = null)
    Parameters
    VanityUrlOptions vanityUrlOptions

    Optionally specify the custom vanity URI's used by this tenant

    Returns
    Task

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer