Interface ISharePointAdmin

SharePoint Admin features

Namespace: PnP.Core.Admin.Model.SharePoint

Assembly: PnP.Core.Admin.dll

Syntax

public interface ISharePointAdmin

Methods

ConnectToHubSite(Uri, Uri, VanityUrlOptions)

Connects a site collection to a hub site. This method can also connect the site collection when the hub site requires approval for connecting new sites.

Declaration

void ConnectToHubSite(Uri siteCollectionUrlToConnect, Uri hubSiteCollectionUrl, VanityUrlOptions vanityUrlOptions = null)

Parameters

Uri siteCollectionUrlToConnect Uri of the site collection to connect to the hub

Uri hubSiteCollectionUrl Uri of the hub to connect the site collection to

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

ConnectToHubSiteAsync(Uri, Uri, VanityUrlOptions)

Connects a site collection to a hub site. This method can also connect the site collection when the hub site requires approval for connecting new sites.

Declaration

Task ConnectToHubSiteAsync(Uri siteCollectionUrlToConnect, Uri hubSiteCollectionUrl, VanityUrlOptions vanityUrlOptions = null)

Parameters

Uri siteCollectionUrlToConnect Uri of the site collection to connect to the hub

Uri hubSiteCollectionUrl Uri of the hub to connect the site collection to

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

Returns

Task

GetTenantAdminCenterContext(VanityUrlOptions)

Returns a PnPContext for the tenant's SharePoint admin center site

Declaration

PnPContext GetTenantAdminCenterContext(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

PnPContext PnPContext for the tenant's SharePoint admin center

GetTenantAdminCenterContextAsync(VanityUrlOptions)

Returns a PnPContext for the tenant's SharePoint admin center site

Declaration

Task<PnPContext> GetTenantAdminCenterContextAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<PnPContext> PnPContext for the tenant's SharePoint admin center

GetTenantAdminCenterUri(VanityUrlOptions)

Returns the SharePoint tenant admin center url (e.g. https://contoso-admin.sharepoint.com)

Declaration

Uri GetTenantAdminCenterUri(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Uri SharePoint tenant admin center url

GetTenantAdminCenterUriAsync(VanityUrlOptions)

Returns the SharePoint tenant admin center url (e.g. https://contoso-admin.sharepoint.com)

Declaration

Task<Uri> GetTenantAdminCenterUriAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<Uri> SharePoint tenant admin center url

GetTenantAdmins(VanityUrlOptions)

Returns a list of ISharePointUsers who are SharePoint Online Tenant admin

Declaration

List<ISharePointUser> GetTenantAdmins(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

PnP.Core.Model.SharePoint.List<ISharePointUser> List of SharePoint Online Tenant admins

GetTenantAdminsAsync(VanityUrlOptions)

Returns a list of ISharePointUsers who are SharePoint Online Tenant admin

Declaration

Task<List<ISharePointUser>> GetTenantAdminsAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<PnP.Core.Model.SharePoint.List<ISharePointUser>> List of SharePoint Online Tenant admins

GetTenantMySiteHostUri(VanityUrlOptions)

Returns the SharePoint tenant my site host url (e.g. https://contoso-my.sharepoint.com)

Declaration

Uri GetTenantMySiteHostUri(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Uri SharePoint tenant my site host url

GetTenantMySiteHostUriAsync(VanityUrlOptions)

Returns the SharePoint tenant my site host url (e.g. https://contoso-my.sharepoint.com)

Declaration

Task<Uri> GetTenantMySiteHostUriAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<Uri> SharePoint tenant my site host url

GetTenantPortalUri(VanityUrlOptions)

Returns the SharePoint tenant portal url (e.g. https://contoso.sharepoint.com)

Declaration

Uri GetTenantPortalUri(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Uri SharePoint tenant portal url

GetTenantPortalUriAsync(VanityUrlOptions)

Returns the SharePoint tenant portal url (e.g. https://contoso.sharepoint.com)

Declaration

Task<Uri> GetTenantPortalUriAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<Uri> SharePoint tenant portal url

GetTenantProperties(VanityUrlOptions)

Gets the properties of this tenant

Declaration

ITenantProperties GetTenantProperties(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

ITenantProperties Properties of the tenant

GetTenantPropertiesAsync(VanityUrlOptions)

Gets the properties of this tenant

Declaration

Task<ITenantProperties> GetTenantPropertiesAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<ITenantProperties> Properties of the tenant

GetTenantSearchConfigurationManagedProperties(VanityUrlOptions)

Gets the managed properties from the search configuration of the tenant

Declaration

List<IManagedProperty> GetTenantSearchConfigurationManagedProperties(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

PnP.Core.Model.SharePoint.List<IManagedProperty> List of managed properties

GetTenantSearchConfigurationManagedPropertiesAsync(VanityUrlOptions)

Gets the managed properties from the search configuration of the tenant

Declaration

Task<List<IManagedProperty>> GetTenantSearchConfigurationManagedPropertiesAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<PnP.Core.Model.SharePoint.List<IManagedProperty>> List of managed properties

GetTenantSearchConfigurationXml(VanityUrlOptions)

Gets the search configuration of the tenant

Declaration

string GetTenantSearchConfigurationXml(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

System.String Search configuration XML

GetTenantSearchConfigurationXmlAsync(VanityUrlOptions)

Gets the search configuration of the tenant

Declaration

Task<string> GetTenantSearchConfigurationXmlAsync(VanityUrlOptions vanityUrlOptions = null)

Parameters

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

Returns

Task<System.String> Search configuration XML

IsCurrentUserTenantAdmin()

Checks if the current user is SharePoint Online tenant admin

Declaration

bool IsCurrentUserTenantAdmin()

Returns

System.Boolean True if the user is a SharePoint Online tenant admin, false otherwise

IsCurrentUserTenantAdminAsync()

Checks if the current user is SharePoint Online tenant admin

Declaration

Task<bool> IsCurrentUserTenantAdminAsync()

Returns

Task<System.Boolean> True if the user is a SharePoint Online tenant admin, false otherwise

SetTenantSearchConfigurationXml(String, VanityUrlOptions)

Sets the search configuration for the tenant

Declaration

void SetTenantSearchConfigurationXml(string configuration, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String configuration Search configuration, obtained via GetTenantSearchConfigurationXml(VanityUrlOptions) to apply

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

SetTenantSearchConfigurationXmlAsync(String, VanityUrlOptions)

Sets the search configuration for the tenant

Declaration

Task SetTenantSearchConfigurationXmlAsync(string configuration, VanityUrlOptions vanityUrlOptions = null)

Parameters

System.String configuration Search configuration, obtained via GetTenantSearchConfigurationXml(VanityUrlOptions) to apply

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

Returns

Task