pem.sharepoint.createSharePointSite

This method is supported by POA starting from version 2.8 hotfix02

This method creates SharePoint Site, which is runned in Exclusive Web Application.

The method has the following input parameters:

Name

Type

Short Description

domain_id

int

ID of Domain on which SharePoint Site is installed.

subscription_id

int

ID of Subscription.

sharepoint_admin_user_id

int

ID of SharePoint Site Administrator Service User.

[notification_email]

string

E-mail address where notification from SharePoint Site(s) is sent. This e-mail address is common for all SharePoint Sites to which Service User is assigned or will be assigned. This parameter is optional. There are the following major use-cases:

  • At the first assigning operation, the notification_email parameter is specified, and this parameter is not specified for the rest assigning operations.
  • At the first assigning operation, the notification_email parameter is specified, and this parameter is specified for the certain assigning operation to redefine the e-mail address.

[application_pool_type]

string

It defines the Application Pool type for SharePoint Site. There are the following options:

  • shared - Shared Application Pool.
  • exclusive - Exclusive Application Pool.

This parameter is optional. If the parameter is not specified, the shared Application Pool type is used.

[ip_address]

boolean

It defines the type of the FrontNet IP Address for SharePoint Site. There are the following options:

  • 0 - In this case a Shared FrontNet IP Address is used. This is default value.
  • 1 - In this case the Exclusive FrontNet IP Address is used from the appropriate IP Pool, which is assigned to the SharePoint host.

language_code

int

Locale ID of Site Template (refer to http://www.microsoft.com/globaldev/reference/lcid-all.mspx to obtain detailed information about Locale ID). The value of this parameter should be obtained from the pem.sharepoint.getAvailableSharePointSiteTemplates method.

[sharepoint_site_template]

string

SharePoint Site Template. This is an optional parameter. There are the following options:

  • Parameter is not specified. In this case a user selects the SharePoint Site Template at first logon to the Site.
  • Parameter is specified. In this case the specified SharePoint Site Template is used. The value of this parameter should be obtained from pem.sharepoint.getAvailableSharePointSiteTemplates method.

[content_quota]

bigint

It defines the content size limit of a single SharePoint Site (in Kilobytes). The minimum and maximum values are 1 KB and 10 GB respectively. This parameter is optional. If the parameter is not specified, the 10 GB value is used.

[existing_users_role]

string

It defines the Role, which is assigned to all Service Users having any SharePoint Sites attached. There are the following options:

  • none - Do not grant any Role.
  • reader - Reader Role.
  • contributor - Contributor Role.
  • webdesigner - Web Designer Role.
  • administrator - Site Administrator Role.

This is an optional parameter. If it is not specified, the none Role is used.

[resources]

struct

It contains a combination of Resource Types, which is used to point out the service targeted for provisioning SharePoint Site.

It is an optional parameter. If it is not specified, a combination of Resource Types is automatically found by POA. If POA detects multiple combinations of Resource Types, which are required for SharePoint Site provisioning, an error is thrown.

  • [sharepoint_sites_resource]

int

ID of Resource Type, which is created on the basis of the SharePoint Sites Resource Class. For example, if a Subscription contains several such Resource Types, the ID of the required Resource Type should be specified.

  • [traffic_resource]

int

ID of Resource Type, which is created on the basis of the Traffic Resource Class. It should be specified, for example, if a separate Resource Type is used to calculate traffic for SharePoint Sites.

  • [diskspace_resource]

int

ID of Resource Type, which is created on the basis of the Diskspace Resource Class. It should be specified, for example, if a separate Resource Type is used to calculate diskspace for SharePoint Sites.

The method has no output parameters.

See also: pem.sharepoint.createSharePointSiteInSharedApplication