Tenant members

  • Article

Represents a SharePoint Online tenant.

The Tenant type exposes the following members.

Constructors

  Name Description
Public method Tenant(ClientRuntimeContext) Creates an instance of the Tenant object.
Public method Tenant(ClientRuntimeContext, ObjectPath) Reserved for internal use.

Top

Properties

  Name Description
Public property AllowDownloadingNonWebViewableFiles
Public property AllowedDomainListForSyncClient
Public property AllowEditing
Public property AllowLimitedAccessOnUnmanagedDevices
Public property ApplyAppEnforcedRestrictionsToAdHocRecipients
Public property BccExternalSharingInvitations
Public property BccExternalSharingInvitationsList
Public property BlockAccessOnUnmanagedDevices
Public property BlockDownloadOfAllFilesForGuests
Public property BlockDownloadOfAllFilesOnUnmanagedDevices
Public property BlockDownloadOfViewableFilesForGuests
Public property BlockDownloadOfViewableFilesOnUnmanagedDevices
Public property BlockMacSync
Public property CommentsOnSitePagesDisabled
Public property CompatibilityRange Gets or sets the value that specifies which compatibility range is available for new site collections.
Public property ConditionalAccessPolicy
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property DefaultLinkPermission
Public property DefaultSharingLinkType
Public property DisableReportProblemDialog
Public property DisallowInfectedFileDownload
Public property DisplayNamesOfFileViewers
Public property DisplayStartASiteOption
Public property EmailAttestationReAuthDays
Public property EmailAttestationRequired
Public property EnableGuestSignInAcceleration
Public property ExcludedFileExtensionsForSyncClient
Public property ExternalServicesEnabled Gets or sets a value that specifies whether external services are enabled.
Public property FileAnonymousLinkType
Public property FilePickerExternalImageSearchEnabled
Public property FolderAnonymousLinkType
Public property HideDefaultThemes
Public property HideSyncButtonOnODB
Public property IPAddressAllowList
Public property IPAddressEnforcement
Public property IPAddressWACTokenLifetime
Public property IsUnmanagedSyncClientForTenantRestricted
Public property IsUnmanagedSyncClientRestrictionFlightEnabled
Public property LegacyAuthProtocolsEnabled
Public property NoAccessRedirectUrl Gets or sets a value for the redirect URL that is used when a site in the tenancy is locked.
Public property NotificationsInOneDriveForBusinessEnabled
Public property NotificationsInSharePointEnabled
Public property NotifyOwnersWhenInvitationsAccepted
Public property NotifyOwnersWhenItemsReshared
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property ODBAccessRequests
Public property ODBMembersCanShare
Public property OfficeClientADALDisabled
Public property OneDriveForGuestsEnabled
Public property OneDriveStorageQuota
Public property OptOutOfGrooveBlock
Public property OptOutOfGrooveSoftBlock
Public property OrphanedPersonalSitesRetentionPeriod
Public property OwnerAnonymousNotification
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property PermissiveBrowserFileHandlingOverride
Public property PreventExternalUsersFromResharing
Public property ProvisionSharedWithEveryoneFolder
Public property PublicCdnAllowedFileTypes
Public property PublicCdnEnabled
Public property PublicCdnOrigins
Public property RequireAcceptingAccountMatchInvitedAccount
Public property RequireAnonymousLinksExpireInDays
Public property ResourceQuota Gets the value of the resource quota for the tenant.
Public property ResourceQuotaAllocated Gets the value of the resource quota allocated to all sites in the tenant.
Public property RootSiteUrl Gets the value of the tenant's root site URL.
Public property SearchResolveExactEmailOrUPN
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property SharingAllowedDomainList
Public property SharingBlockedDomainList
Public property SharingCapability
Public property SharingDomainRestrictionMode
Public property ShowAllUsersClaim
Public property ShowEveryoneClaim
Public property ShowEveryoneExceptExternalUsersClaim
Public property ShowNGSCDialogForSyncOnODB
Public property ShowPeoplePickerSuggestionsForGuestUsers
Public property SignInAccelerationDomain
Public property SocialBarOnSitePagesDisabled
Public property SpecialCharactersStateInFileFolderNames
Public property StartASiteFormUrl
Public property StorageQuota Gets the value of the storage quota that is available for the tenant.
Public property StorageQuotaAllocated Gets the value of the storage quota that is allocated for all sites in the tenant
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property UseFindPeopleInPeoplePicker
Public property UsePersistentCookiesForExplorerView
Public property UserVoiceForFeedbackEnabled

Top

Methods

  Name Description
Public method AddPublicCdnOrigin
Public method AddSdnProvider
Public method AddTenantCdnOrigin
Public method AddTenantTheme
Public method ApplySiteDesign
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method ConnectSiteToHubSite
Public method CreateGroupForSite
Public method CreateSite Queues a site collection for creation with the specified properties.
Public method CreateSiteDesign
Public method CreateSiteScript
Public method CreateTenantCdnDefaultOrigins
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method DecodeClaim Returns a string that represents the decoded claim (the login name) for the specified encoded claim.
Public method DecodeClaims Returns a list of decoded claims (login names) for the specified list of encoded claims.
Public method DeleteSiteDesign
Public method DeleteSiteScript
Public method DeleteTenantTheme
Public method DisconnectSiteFromHubSite
Public method EncodeClaim Returns an encoded claim for the specified login name.
Public method EncodeClaims Returns a list of encoded claims for the specified list of login names.
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetAllDeletedPersonalSitesPropertiesAllVersions
Public method GetAllTenantThemes
Public method GetAppErrors Gets errors from the app monitoring framework for the specified app within tenant scope.
Public method GetAppInfoByName Gets apps that match the specified search string.
Public method GetAppInfoByProductId Gets apps that match the specified identifier.
Public method GetDeletedPersonalSitePropertiesAllVersions
Public method GetDeletedSiteProperties Returns a list of properties of deleted sites for the current tenant.
Public method GetDeletedSitePropertiesByUrl Gets the properties of the specified deleted site.
Public method GetDeletedSitePropertiesFromSharePoint
Public method GetHubSitePropertiesById
Public method GetHubSitePropertiesByUrl
Public method GetHubSitesProperties
Public method GetIdleSessionSignOutForUnmanagedDevices
Public method GetRootSiteUrl
Public method GetSiteByUrl Returns a site for the specified URL
Public methodStatic member GetSiteDesign
Public methodStatic member GetSiteDesignRights
Public method GetSiteDesigns
Public method GetSiteProperties Returns the properties for all sites in the tenant.
Public method GetSitePropertiesByFilter Returns properties for all sites in the tenant that match the filter expression.
Public method GetSitePropertiesByUrl Returns properties for the site with the specified URL.
Public method GetSitePropertiesFromSharePoint
Public method GetSitePropertiesFromSharePointByFilter
Public method GetSitePropertiesFromSharePointByFilters
Public methodStatic member GetSiteScript
Public method GetSiteScripts
Public method GetSPOTenantAllWebTemplates
Public method GetSPOTenantWebTemplates Returns all of the web templates for the site collections in the tenant.
Public method GetTenantCdnEnabled
Public method GetTenantCdnOrigins
Public method GetTenantCdnPolicies
Public method GetTenantInstances
Public method GetTenantTheme
Public method GetUserMigrationProperties
Public method GetUserMigrationPropertiesByFilter
Public method GrantHubSiteRights
Public method GrantSiteDesignRights
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson Reserved for internal use. (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RegisterHubSite
Public method RemoveDeletedSite Permanently removes the specified deleted site from the recycle bin.
Public method RemoveDeletedSitePreferId
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method RemovePublicCdnOrigin
Public method RemoveSdnProvider
Public method RemoveSite Deletes the site with the specified URL.
Public method RemoveTenantCdnOrigin
Public method RequestPersonalSites
Public method RestoreDeletedSite Restores the previously deleted site from the recycle bin.
Public method RestoreDeletedSitePreferId
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method RevokeHubSiteRights
Public methodStatic member RevokeSiteDesignRights
Public method SetIdleSessionSignOutForUnmanagedDevices
Public method SetSiteAdmin Adds user as a site administrator.
Public method SetTenantCdnEnabled
Public method SetTenantCdnPolicy
Public method SetWebTheme
Public method ToString (Inherited from Object.)
Public method UnregisterHubSite
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Public method UpdateSiteDesign
Public method UpdateSiteScript
Public method UpdateTenantTheme
Public method UpdateUserTypeFromAzureAD
Public method UpdateUserTypeFromAzureADForAllSites
Public method UpdateUserTypesFromAzureADForSite

Top

See also

Reference

Tenant class

Microsoft.Online.SharePoint.TenantAdministration namespace