Interface ISiteCollectionProperties

Namespace

PnP.Core.Admin.Model.SharePoint

Assembly

PnP.Core.Admin.dll

Properties of a site collection

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

bool AllowDownloadingNonWebViewableFiles { get; set; }

Property Value

bool

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.

bool AllowEditing { get; set; }

Property Value

bool

AllowSelfServiceUpgrade

Flag that indicates is a site supports self-service upgrade

bool AllowSelfServiceUpgrade { get; set; }

Property Value

bool

AnonymousLinkExpirationInDays

Anonymous link expiration in days

int AnonymousLinkExpirationInDays { get; set; }

Property Value

int

AuthContextStrength

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

[Obsolete("Please use the AuthenticationContextName property")]
string AuthContextStrength { get; set; }

Property Value

string

AuthenticationContextName

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

string AuthenticationContextName { get; set; }

Property Value

string

BlockDownloadLinksFileType

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

BlockDownloadLinksFileTypes BlockDownloadLinksFileType { get; set; }

Property Value

BlockDownloadLinksFileTypes

BlockDownloadPolicy

Gets or sets the Block download policy flag

bool BlockDownloadPolicy { get; set; }

Property Value

bool

ClearRestrictedAccessControl

Clears the Restricted access control groups

bool ClearRestrictedAccessControl { get; set; }

Property Value

bool

CommentsOnSitePagesDisabled

Whether comments on site pages are disabled or not

bool CommentsOnSitePagesDisabled { get; set; }

Property Value

bool

CompatibilityLevel

The compatibility leve of this site

int CompatibilityLevel { get; }

Property Value

int

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)

SPOConditionalAccessPolicyType ConditionalAccessPolicy { get; set; }

Property Value

SPOConditionalAccessPolicyType

DefaultLinkPermission

The default link permission for this site

SharingPermissionType DefaultLinkPermission { get; set; }

Property Value

SharingPermissionType

DefaultLinkToExistingAccess

The default link to existing access for this site

bool DefaultLinkToExistingAccess { get; set; }

Property Value

bool

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

bool DefaultLinkToExistingAccessReset { get; set; }

Property Value

bool

DefaultShareLinkRole

Default share link role

Role DefaultShareLinkRole { get; set; }

Property Value

Role

DefaultShareLinkScope

Default share link scope

SharingScope DefaultShareLinkScope { get; set; }

Property Value

SharingScope

DefaultSharingLinkType

The default link type for this site

SharingLinkType DefaultSharingLinkType { get; set; }

Property Value

SharingLinkType

DenyAddAndCustomizePages

Determines whether the site has AddAndCustomizePages denied

DenyAddAndCustomizePagesStatus DenyAddAndCustomizePages { get; set; }

Property Value

DenyAddAndCustomizePagesStatus

Description

Site's description

string Description { get; }

Property Value

string

DisableAppViews

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

AppViewsPolicy DisableAppViews { get; set; }

Property Value

AppViewsPolicy

DisableCompanyWideSharingLinks

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

CompanyWideSharingLinksPolicy DisableCompanyWideSharingLinks { get; set; }

Property Value

CompanyWideSharingLinksPolicy

DisableFlows

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

FlowsPolicy DisableFlows { get; set; }

Property Value

FlowsPolicy

ExcludeBlockDownloadPolicySiteOwners

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

bool ExcludeBlockDownloadPolicySiteOwners { get; set; }

Property Value

bool

ExternalUserExpirationInDays

External user expiration in days

int ExternalUserExpirationInDays { get; set; }

Property Value

int

GroupId

The GroupId of the site

Guid GroupId { get; }

Property Value

Guid

GroupOwnerLoginName

The login name of the group owner

string GroupOwnerLoginName { get; }

Property Value

string

HasHolds

Flag that indicates a site has Holds

bool HasHolds { get; }

Property Value

bool

HubSiteId

The HubSiteId of the HubSite this site is associated with

Guid HubSiteId { get; }

Property Value

Guid

IBMode

get or Set IBMode (Information Barrier Mode)

string IBMode { get; set; }

Property Value

string

IBSegments

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

Guid[] IBSegments { get; set; }

Property Value

Guid[]

IBSegmentsToAdd

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

Guid[] IBSegmentsToAdd { get; set; }

Property Value

Guid[]

IBSegmentsToRemove

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

Guid[] IBSegmentsToRemove { get; set; }

Property Value

Guid[]

IsGroupOwnerSiteAdmin

Whether group owner is site admin

bool IsGroupOwnerSiteAdmin { get; }

Property Value

bool

IsHubSite

Whether or not this site is a HubSite

bool IsHubSite { get; }

Property Value

bool

IsTeamsChannelConnected

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

bool IsTeamsChannelConnected { get; }

Property Value

bool

IsTeamsConnected

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

bool IsTeamsConnected { get; }

Property Value

bool

LastContentModifiedDate

The last time content was modified on the site

DateTime LastContentModifiedDate { get; }

Property Value

DateTime

Lcid

The Locale ID of the site

int Lcid { get; set; }

Property Value

int

LimitedAccessFileType

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

SPOLimitedAccessFileType LimitedAccessFileType { get; set; }

Property Value

SPOLimitedAccessFileType

LockIssue

A description of the lock issue

string LockIssue { get; }

Property Value

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

string LockState { get; set; }

Property Value

string

MediaTranscription

Gets or sets the media transcription policy

MediaTranscriptionPolicyType MediaTranscription { get; set; }

Property Value

MediaTranscriptionPolicyType

OverrideBlockUserInfoVisibility

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

SiteUserInfoVisibilityPolicyValue OverrideBlockUserInfoVisibility { get; set; }

Property Value

SiteUserInfoVisibilityPolicyValue

OverrideTenantAnonymousLinkExpirationPolicy

This site overrides the tenant anonymous link expiration policy

bool OverrideTenantAnonymousLinkExpirationPolicy { get; set; }

Property Value

bool

OverrideTenantExternalUserExpirationPolicy

This site overrides the tenant external user expiration policy

bool OverrideTenantExternalUserExpirationPolicy { get; set; }

Property Value

bool

Owner

The decoded login name of the site owner

string Owner { get; set; }

Property Value

string

OwnerEmail

The email address of the site owner

string OwnerEmail { get; }

Property Value

string

OwnerLoginName

The encoded login name of the site owner

string OwnerLoginName { get; }

Property Value

string

OwnerName

The site owner name

string OwnerName { get; }

Property Value

string

PWAEnabled

Determines whether PWA is enabled for the site

PWAEnabledStatus PWAEnabled { get; set; }

Property Value

PWAEnabledStatus

ReadOnlyForUnmanagedDevices

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

bool ReadOnlyForUnmanagedDevices { get; set; }

Property Value

bool

RelatedGroupId

The GroupId of the group this site is associated with

Guid RelatedGroupId { get; }

Property Value

Guid

RequestFilesLinkEnabled

Gets or sets request files link enabled

bool RequestFilesLinkEnabled { get; set; }

Property Value

bool

RequestFilesLinkExpirationInDays

Gets or sets request files link expiration days

int RequestFilesLinkExpirationInDays { get; set; }

Property Value

int

RestrictedAccessControl

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

bool RestrictedAccessControl { get; set; }

Property Value

bool

RestrictedAccessControlGroups

Gets or sets the Restricted Access Control Groups

IList<Guid> RestrictedAccessControlGroups { get; set; }

Property Value

IList<Guid>

RestrictedAccessControlGroupsToAdd

Gets or sets the restricted access control groups to be added

IList<Guid> RestrictedAccessControlGroupsToAdd { get; set; }

Property Value

IList<Guid>

RestrictedAccessControlGroupsToRemove

Gets or sets the restricted access control groups to be removed

IList<Guid> RestrictedAccessControlGroupsToRemove { get; set; }

Property Value

IList<Guid>

RestrictedToRegion

Determines whether the site is resticted to a specific geo location

RestrictedToRegion RestrictedToRegion { get; set; }

Property Value

RestrictedToRegion

SensitivityLabel

The Guid of an Information Protection label

Guid SensitivityLabel { get; set; }

Property Value

Guid

SensitivityLabel2

The Guid of an Information Protection label

string SensitivityLabel2 { get; set; }

Property Value

string

SetOwnerWithoutUpdatingSecondaryAdmin

Whether update secondary admin during setting primary admin

bool SetOwnerWithoutUpdatingSecondaryAdmin { get; set; }

Property Value

bool

SharingAllowedDomainList

A list of allowed domain names for this site

string SharingAllowedDomainList { get; set; }

Property Value

string

SharingBlockedDomainList

A list of blocked domain names for this site

string SharingBlockedDomainList { get; set; }

Property Value

string

SharingCapability

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

SharingCapabilities SharingCapability { get; set; }

Property Value

SharingCapabilities

SharingDomainRestrictionMode

Indicates what this site's domain restriction mode is

SharingDomainRestrictionModes SharingDomainRestrictionMode { get; set; }

Property Value

SharingDomainRestrictionModes

SharingLockDownCanBeCleared

Get whether the sharing lock can be cleared

bool SharingLockDownCanBeCleared { get; }

Property Value

bool

SharingLockDownEnabled

Gets the SharingLockDownEnabled setting

bool SharingLockDownEnabled { get; }

Property Value

bool

ShowPeoplePickerSuggestionsForGuestUsers

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

bool ShowPeoplePickerSuggestionsForGuestUsers { get; set; }

Property Value

bool

SiteDefinedSharingCapability

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

SharingCapabilities SiteDefinedSharingCapability { get; }

Property Value

SharingCapabilities

SocialBarOnSitePagesDisabled

Whether social bar on site pages is enabled or not

bool SocialBarOnSitePagesDisabled { get; set; }

Property Value

bool

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

string Status { get; }

Property Value

string

StorageMaximumLevel

The Storage Quota

long StorageMaximumLevel { get; set; }

Property Value

long

StorageQuotaType

The storage quota type for the site

string StorageQuotaType { get; }

Property Value

string

StorageUsage

The current usage of storage for the site

long StorageUsage { get; }

Property Value

long

StorageWarningLevel

The warning level for storage usage

long StorageWarningLevel { get; set; }

Property Value

long

TeamsChannelType

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

TeamsChannelTypeValue TeamsChannelType { get; }

Property Value

TeamsChannelTypeValue

Template

The site's web template name

string Template { get; set; }

Property Value

string

TimeZoneId

The TimeZone

TimeZone TimeZoneId { get; set; }

Property Value

TimeZone

Title

The site's title

string Title { get; set; }

Property Value

string

Url

The Url of the site

string Url { get; }

Property Value

string

WebsCount

The number of webs in the site

int WebsCount { get; }

Property Value

int

Methods

Update(VanityUrlOptions)

Updates the properties of this site collection

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

Task UpdateAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

vanityUrlOptions VanityUrlOptions

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

Returns

Task