Home > Manage Templates > Configure Service Templates > Configure JSON Files for the Create Site Collection Service
Download this articleConfigure JSON Files for the Create Site Collection Service
Refer to the following sections to configure the JSON files for a Create Site Collection service and the associated policy, approval process, profiles, etc.
Create Site Collection Service
The following table shows the properties of a Create Site Collection service.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateSiteService. It indicates that the JSON file is used for the Create Site Collection service. | Enum | |
| AdminCenter | Enter a SharePoint admin center URL. | String | |
| UseSharePointOnlineContext | Set to true if you want to use SharePoint context to automatically populate the service request scope. | Boolean | |
| SharePointOnlineContextAssignBy | Use SharePoint context to automatically populate the service request scope. | Enum | Valid values: AllowBusinessUserEditURL (Business users are allowed to change the request scope.) ShowasReadOnlytoBusinessUser (The request scope is shown as read-only to business users.) HidefromBusinessUser (Do not show the request scope to business users.) |
| DefaultManagedPath | Enter the associated managed path for the site collections that will be created via requests for this service. | String | Valid values: /sites/ /teams/ |
| TemplateSettings > SelectedTemplates | Enter the name of the site types. | String collection | |
| TemplateSettings > DefaultTemplate | Define a default site type. | String | |
| TemplateSettings > TemplateAssignBy | You define the site type to create site collections, or allow business users to choose the site type from the available types when submitting a service request for this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the site type.) ITAdminWithReadOnly (IT administrator selects the site type and the type is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the site type and the type is not shown in the request form.) |
| SitePolicyTemplateSettings > SelectedTemplates | Define the site type for the selected site collection policy to make sure at least one site type is selected for the policy. | String collection | If there are multiple policies and you want to specify site types for each policy, make sure these three properties are configured for each policy: SelectedTemplates, DefaultTemplate, PolicyName. |
| SitePolicyTemplateSettings > DefaultTemplate | Define a default site type. | String | |
| SitePolicyTemplateSettings > PolicyName | Enter the policy name for which you want to select the site type. | String | |
| TimeZone | Define the time zone for the site collections. | String | |
| TimeZoneAssignBy | You assign the time zone to site collections created by this service, or allow business users to select the time zone when submitting a service request for this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the time zone.) ITAdminWithReadOnly (IT administrator selects the time zone and the time zone is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the time zone and the time zone is not shown in the request form.) |
| SharePointGroupSettings > PermissionAssignBy | You define the site collection permissions or allow business users to define this setting in the request forms. | Enum | Valid values: BusinessUserWithRequired (Business users are required to configure site collection permissions.) ITAdminWithReadOnly (IT administrator configures site collection permissions and the permissions are shown as read-only to business users.) ITAdminWithHide (IT administrator configures site collection permissions and the permissions are not shown in the request form.) |
| SharePointGroupSettings > TemplatePermRelatedSettings > EnableGrantPermission | Set to true if you want to allow Business User to grant user permissions directly. | Boolean | |
| SharePointGroupSettings > TemplatePermRelatedSettings > EnablePreventGrantPermission | Set to true if you want to prevent Business Users from requesting to grant permissions with specific permission levels. | Boolean | |
| SharePointGroupSettings > TemplatePermRelatedSettings > PermissionLevels | Specify the permission levels that users cannot grant to specific users in the request. | String collection | |
| Groups > Template | Specify the site type to define permissions. | String | |
| Groups > IsUseCommon | Set to true if you want to use common permission settings for site collections with the specific site type. | Boolean | |
| Groups > Name | Enter a name for the new custom group. | String | |
| Groups > GroupOwner | Specify a group owner. | String | |
| Groups > EnableUserAsOwner | Set to true if you want to specify a Microsoft 365 user to be the group owner. Set to false if you want to specify a SharePoint group to be the group owner. | Boolean | |
| Groups > EnableChangePermission | Set to true if you allow the business user to change the permission level of this group. | Boolean | |
| Groups > SecurityGroupsType | Specify a Microsoft 365 user or SharePoint Online group to be the group owner. | Enum | Valid values: Group User |
| Groups > PermissionLevels | Specify one or more permission levels for the group. | String collection | |
| Groups > GroupOwnerAssignBy | You assign the group owner to the custom group that will be created together with the site collection created via this service, or allow business users to assign the group owner when submitting requests for this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the group owner.) ITAdminWithReadOnly (IT administrator selects the group owner and the group owner is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the group owner and the group owner is not shown in the request form.) |
| Groups > PermissionAssignmentAssignBy | If you choose to create a new group to assign specific permission to the group, then you must decide whether to specify users to be included in the custom group, or allow business users to specify users of the group. If you choose to grant permissions to specific users, then you must decide whether you want to assign the user permissions or allow business users to assign user permissions. | Enum | Valid values: BusinessUserWithRequired (Business users are required to specify users of the group, or business users are required to assign the user permissions.) ITAdminWithReadOnly (IT administrator specifies the users of the group and the users of the group are shown as read-only to business users, or IT administrator assigns the user permissions and the user permissions are shown as read-only to business users.) ITAdminWithHide (IT administrator specifies the users of the group and the users are not shown in the request form, or IT administrator assigns the user permissions and the user permissions are not shown to business users.) |
| Users > User | Enter the username of the user to include in this group. | String | |
| Users > IsHide | Set to true if you want to hide the enforced user from the request page. | Boolean | |
| Users > IsEnforcePermission | Set to true if you want to enable the Enforce Permission and the requester cannot remove the user or change the user's permissions. | Boolean | |
| AdminSettings > AdditionalAdmins | Assign one or more users to be the additional site collection administrators of the new site collection. You can also enter certain user roles to be the additional administrator. | String collection | Valid user roles: $Requester $ManagerOfRequester $PrimarySiteCollectionContact $SecondarySiteCollectionContact |
| AdminSettings > AdditionalAdminAssignBy | You assign the additional site collection administrators to site collections created by this service, or allow business users to choose the additional site collection administrators when submitting a service request for this service. | Enum | Valid values: BusinessUser (Business users can select the additional site collection administrator.) BusinessUserWithRequired (Business users are required to select the additional site collection administrator.) ITAdminWithReadOnly (IT administrator selects the additional site collection administrator and the additional site collection administrator is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the additional site collection administrator and the additional site collection administrator is not shown in the request form.) |
| AdminSettings > PrimaryAdmin | Enter a username or user role to specify users to be the primary site collection administrator. | String | Valid user roles: $Requester $ManagerOfRequester $PrimarySiteCollectionContact $SecondarySiteCollectionContact |
| AdminSettings > PrimaryAdminAssignBy | You assign the primary site collection administrator to site collections created by this service, or allow business users to choose the primary site collection administrator when submitting a service request for this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the primary site collection administrator.) ITAdminWithReadOnly (IT administrator selects the primary site collection administrator and the primary administrator is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the primary site collection administrator and the primary administrator is not shown in the request form.) |
| DPMSettings > EnableDPM | Set to true if you want to apply an AvePoint Cloud Management Deployment Manager plan to the new site collection. | Boolean | |
| DPMSettings > DPMPlans | Enter one or more names of Deployment Manager plans. | String collection | |
| DPMSettings > DefaultDPMPlan | Enter the name of a plan to be the default Deployment Manager plan. | String | |
| DPMSettings > DPMAssignBy | You assign the selected Deployment Manager plan to site collections created by this service, or allow business users to select the Deployment Manager plan when submitting a service request. | Enum | Valid values: BusinessUser (Business users can select a Deployment Manager plan.) BusinessUserWithRequired (Business users are required to select a Deployment Manager plan.) ITAdminWithReadOnly (IT administrator selects a Deployment Manager plan and the plan is shown as read-only to business users.) ITAdminWithHide (IT administrator selects a Deployment Manager plan and the plan is not shown in the request form.) |
| LeasePeriodSettings > EnableLease | Set to true if you want to enable the site collection lease period. | Boolean | |
| LeasePeriodSettings > LeaseDuration | Enter a number to specify the amount of time of the lease period. | Int32 | |
| LeasePeriodSettings > LeaseDurationType | Define the unit of time for the lease period. | Enum | Valid values: Day Week Month Year |
| LeasePeriodSettings > LeaseDurationAssignby | You assign the lease period to site collections created by this service, or allow business users to choose the site collection lease period when submitting a service request for this service. | Enum | |
| LeasePeriodSettings > EnableLeaseWarn | Set to true if you want to enable a lease expiration warning. | Boolean | |
| LeasePeriodSettings > LeaseWarnDuration | Enter a number to specify the amount of time before the lease reaches expiration. A warning e-mail will be sent to the approver before the site collection lease reaches expiration. | Int32 | |
| LeasePeriodSettings > LeaseWarnDurationType | Specify the unit of time for the duration before the lease reaches expiration. | Enum | Valid values: Day Week Month Year |
| LeasePeriodSettings > LeaseWarnDurationAssignby | You assign the lease expiration warning setting to site collections created by this service, or allow business users to configure the lease expiration warning setting when submitting a service request for this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to configure the lease expiration warning setting.) ITAdminWithReadOnly (IT administrator configures the lease expiration warning setting and the setting is shown as read-only to business users.) ITAdminWithHide (IT administrator configures the lease expiration warning setting and the setting is not shown in the request form.) |
| LeasePeriodSettings > ApprovalProcess | Specify an approval process that will be used for the site collection lease expiration task. Enter an approval process name. | String | |
| LeasePeriodSettings > EnableNotifyWhenExpiration | Set to true if you want to notify the approver of the lease expiration. | Boolean | |
| LeasePeriodSettings > ExpirationEmailTemplate | Enter the name of an e-mail template that will be used to send the e-mail notification. | String | |
| LeasePeriodSettings > EnableWarnBeforeExpiration | Set to true if you want to notify the approver before the site collection lease expires. | Boolean | |
| LeasePeriodSettings > WarnEmailTemplate | Enter the name of an e-mail template that will be used to send the e-mail notification. | String | |
| AppPartSettings > EnableAutoApp | Set to true if you want to automatically enable AvePoint Cloud Governance App during the site collection creation. | Boolean | |
| AppPartSettings > EnableAddToSiteInfoCard | Set to true if you want to automatically add the Site Information Card app part to the homepage of the site collection that will be created by this service. | Boolean | |
| AppPartSettings > EnableAddToTimeline | Set to true if you want to automatically add the Site Collection Timeline app part to the homepage of the site collection that will be created by this service. | Boolean | |
| AppPartSettings > EnableAddToPanel | Set to true if you want to automatically add the Cloud Governance Panel app part to the homepage of the site collection that will be created by this service. | Boolean | |
| YammerSettings > EnableYammerIntegrate | Set to true if you want to enable the integration between AvePoint Cloud Governance and Viva Engage. | Boolean | |
| YammerSettings > YammerName | Enter a Viva Engage network name to connect AvePoint Cloud Governance to the Viva Engage network. | String | |
| YammerSettings > AllowCreateYammerGroup | Set to true if you want to allow business users to create a new Viva Engage internal group. | Boolean | |
| YammerSettings > YammerGroupType | Define a group type for the new groups. The group type determines who can view the group content. | Enum | Valid values: Public Private |
| YammerSettings > EnableListInYammerGroupDirectory | Set to true if you want to have the approved members listed in the private group directory. | Boolean | |
| YammerSettings > YammerGroupJoinType | Define the group permission for the new groups. The group permission determines who can join the group. | Enum | Valid values: Anyone AdminApproved |
| YammerSettings > YammerGroupJoinTypeAssignBy | You apply the new Viva Engage internal group settings configured here to the site collections created by this service, or allow business users to configure the new Viva Engage internal group settings when submitting requests via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to configure the new Viva Engage internal group settings.) ITAdminWithReadOnly (IT administrator configures the new Viva Engage internal group settings and the settings are shown as read-only to business users.) ITAdminWithHide (IT administrator configures the new Viva Engage internal group settings and the settings are not shown in the request form.) |
| YammerSettings > AllowUseExistYammerGroup | Set to true if you want to allow business users to use an existing Viva Engage group when submitting a request for this service. | Boolean | |
| YammerSettings > EnableEnforceTheExistGroup | Set to true if you want to apply an existing Viva Engage group to the site collection created via this service. | Boolean | |
| YammerSettings > EnforceExistingGroupNameOrId | Enter the name or ID of an existing Viva Engage group. | String | |
| TitleConstructSettings > EnableConstructTitle | Set to true if you want to set rules for the titles of new site collections created via this service. | Boolean | |
| TitleConstructSettings > ConstructRuleAssignBy | You define the titles of site collections created via this service, or allow business users to define site collection titles based on the prefixes/suffixes in your rules. | Enum | Valid values: BusinessUser (Business users can define site collection titles based on the prefixes/suffixes.) BusinessUserWithRequired (Business users are required to add additional content to the site collection title.) ITAdminWithReadOnly (The site collection title is shown as read-only to business users.) |
| TitleConstructSettings > PrefixItems > Type | Use Text or Metadata as a rule. | Enum | Valid values: Text Metadata |
| TitleConstructSettings > PrefixItems > Value | Define the value of the rule. | String | |
| TitleConstructSettings > SuffixItems > Type | Use Text or Metadata as a rule. | Enum | Valid values: Text Metadata |
| TitleConstructSettings > SuffixItems > Value | Define the value of the rule. | String | |
| UrlConstructSettings > ConstructUrlType | Define how to construct the site collection URL. | Enum | Valid values: ManualInputUrl AutoGenerateUrl |
| UrlConstructSettings > ManuallyUrlSettings > EnableConstructUrl | Set to true if you want to build the site collection URL using specific rules. | Boolean | |
| UrlConstructSettings > ManuallyUrlSettings > EnableUrlValidation | Set to true if you want to validate the site collection URL against the regular expression set in a text validation rule. | Boolean | |
| UrlConstructSettings > ManuallyUrlSettings > UrlValidationRuleProfile | Enter the name of a text validation rule. The rule can be created in the classic Cloud Governance admin center > Settings > Text Validation Rule Management. | String | |
| UrlConstructSettings > ManuallyUrlSettings > UrlConnection | Enter the connection character for connecting the values of multiple rules. | String | |
| UrlConstructSettings > ManuallyUrlSettings > ConstructUrlAssignBy | You define the site collection URL rules, or allow business users to add additional content to the site collection URL when submitting requests via this service. | Enum | Valid values: BusinessUserWithRequired (The rules are used to generate the site collection URL and business users are required to add additional content to the URL.) ITAdminWithReadOnly (The rules are used to generate the site collection URL and the URL is shown as read-only to business users.) |
| UrlConstructSettings > ManuallyUrlSettings > UrlSuffix | Enter the suffix for the site collection URL. | String | |
| ManuallyUrlSettings > ConstructUrlRules > Value | To construct the site collection URL using the site collection title or custom metadata configured in your tenant, enter the name of the site collection title or metadata. | String | Valid values: Title Metadata name |
| ManuallyUrlSettings > ConstructUrlRules > IsMetadata | Set to true if you want to use custom metadata to construct the site collection URL. | Boolean | |
| AutoGenerateUrlSettings > AutoGenerateUrlType | Choose the method from sequential numbering and random strings to define the URL according to the corresponding format. | Enum | Valid values: SequentialNumber RandomString |
| AutoGenerateUrlSettings > AutoGeneratePrefix | This is for the random string method. Enter the prefix of the site collection URL. | String | |
| AutoGenerateUrlSettings > AutoGenerateMin | This is for the random string method. Define the minimum length of the URL name. | Int32 | |
| AutoGenerateUrlSettings > AutoGenerateMax | This is for the random string method. Define the maximum length of the URL name. | Int32 | |
| AutoGenerateUrlSettings > UrlPatternPrefix | This is for the sequential numbering method. Enter the prefix of the site collection URL. | String | |
| AutoGenerateUrlSettings > UrlPatternDelimiter | This is for the sequential numbering method. Enter the delimiter of the site collection URL, you can enter any character except invalid URL characters. | String | |
| AutoGenerateUrlSettings > UrlPatternSequenceNum | This is for the sequential numbering method. Define the sequence number in the site collection URL. | String | |
| SkipNotGAOData | This property is for the profiles that are not created in AvePoint Cloud Governance. Set to true if you want to disable related settings when the specified profiles cannot be found. | Boolean | |
| HideRequestSummary | Set to true if you want to hide the Request Summary field from the request form and use the service name and timestamp to automatically generate the request summary. | Boolean | |
| Language | Define the service language. The service language can be used to filter services when a business user starts a request. | String | Valid values: English French German Japanese Italian |
| SingleApprovalProcess | Define a single approval process that will be used for the service. Enter the name of an approval process. | String | |
| Category | Enter the name of a category that is used to organize the service. | String | |
| AvailableAsQuestionaireResult | Set to true if you want to allow business users to access this service via questionnaire results. | Boolean | |
| AnyUserCanAccessByQuestionnaire | Set to true if you want to allow all business users to access this service via questionnaire results regardless of the service permission conditions. | Boolean | |
| ShowServiceInCatalog | Set to true if you want to allow business users to access this service via the service catalog. | Boolean | |
| AdminContact | Enter the name of a user or a Microsoft Entra group to be the administrator contact who is responsible for the successful completion of the service. | String | |
| ServiceContact | Enter the name of a user to be the service contact who will be the owner of the business process for the service. | String | |
| EnableMultipleApprovalProcess | Set to true if you want to enable multiple approval processes that will be used for the service under certain conditions. | Boolean | |
| MultipleApprovalProcess > ConditionalApprovalProcesses > Name | Enter a name for the conditional approval process. | String | |
| MultipleApprovalProcess > ConditionalApprovalProcesses > AlwaysRun | Set to true if you want to always run this approval process. | Boolean | |
| ConditionSettings > Relation | Specify the logic option for the multiple added conditions. | Enum | Valid values: And Or |
| ConditionSettings > SourceType | Specify the metadata source type. | Enum | Valid value: ServiceMetadata |
| ConditionSettings > Condition | Specify the condition to define the metadata value. | Enum | Valid values: Equals |
| ConditionSettings > Value | Enter the metadata value. | String | |
| ConditionSettings > MetadataName | Enter the metadata name. | String | |
| ConditionSettings > ApprovalProcess | Specify an approval process that will be combined with the conditions configured above to create a conditional approval process. Enter an approval process name. | String | |
| ConditionSettings > DefaultApprovalProcess | Specify a default approval process for the service. Enter an approval process name. | String | |
| ConditionSettings > DefaultProcessMustDo | Set to true if you want to use the default approval process as the last approval stage for all of the requests submitted via this service. | Boolean | |
| ConditionSettings > EnableCompletionEmail | Set to true if you want to notify the requester and the approvers upon the request completion. | Boolean | |
| ConditionSettings > CompletionEmailTemplate | Enter the name of an e-mail template used for sending notification e-mails to the requester and approvers. | String | |
| ServicePermissions > AllowAnyUserAccess | Set to true if you want to allow all users to use this service. | Boolean | |
| ServicePermissions > MeetAllConditions | Set to true if you want to allow business users who meet certain conditions to use this service. | Boolean | |
| ServicePermissionDetails > PermissionType > Name | Specify conditions for users who meet certain conditions can use the request. | String | Valid values: UserOrGroup AzureADProperty |
| ServicePermissionDetails > Value | Define values for the corresponding condition type. Enter usernames or group names if you choose to configure the condition as UserOrGroup, or enter property name and property values for the AzureADProperty condition. | String | To specify the condition as AzureADProperty, enter property name and value in the format of Property name (Property value). |
| ServicePermissionDetails > Tenant | Enter your Microsoft 365 tenant name. | String | |
| ServicePermissionDetails > PropertyInputType | Specify the Microsoft Entra property type. | Enum | Valid values: None Dropdown (It represents the built-in property.) Manual (It represents the custom property.) |
| Metadatas > Name | Enter the metadata name. | String | |
| Metadatas > AssignBy | You set a default value for the metadata or allow business users to assign the metadata value. | Enum | Valid values: BusinessUser (Business users can define the metadata value.) BusinessUserWithRequired (Business users are required to define the metadata value.) ITAdminWithReadOnly (IT administrator defines the metadata value and the value is shown as read-only to business users.) ITAdminWithHide (IT administrator defines the metadata value and the value is not shown in the request form.) |
| SingleLineOrMultipleLineTypeValue > Value | Enter a default value for the metadata. | String | |
| LinkTypeValue > Title | Enter the desired text to be the hyperlink title. | String | |
| LinkTypeValue > Address | Enter the address of the hyperlink. | String | |
| ChoiceTypeValue > Values | Enter the choices you wish to provide. | String collection | |
| UserProfileTypeValue > Value | Enter a username to get the user's property value from the user profile. | String | |
| AzureAdTypeValue > Value | Enter a username to get the user's property value from Microsoft Entra. | String | |
| UserTypeValue > Values | Enter usernames or group names. | String collection | |
| ManagedTypeValue > Values | Enter terms that have been configured in your SharePoint term store. | String collection | |
| YesOrNoTypeValue > Value | Specify a default value for the metadata, true or false. | Boolean | |
| YesOrNoTypeValue > EnableTerms | Set to true if you want to enable the desired terms and conditions. Note that if you enable the terms and conditions agreement, only Yes can be the default value. | Boolean | |
| YesOrNoTypeValue > DefaultTermLanguage | Specify a default display language for the terms and conditions. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| YesOrNoTypeValue > TermsAndConditions > Language | Specify a language for the terms and conditions. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| YesOrNoTypeValue > TermsAndConditions > Term | Define the terms and conditions. | String | |
| YesOrNoTypeValue > TermsAndConditions > TrueValue | Enter your preferred value to replace Yes. | String | |
| YesOrNoTypeValue > TermsAndConditions > FalseValue | Enter your preferred value to replace No. | String | |
| YesOrNoTypeValue > TermsAndConditions > IsEnableCustomValue | Set to true if you change default terms and conditions metadata to your preferred values. | Boolean | |
| YesOrNoTypeValue > TermsAndConditions > IsEnabled | Set to true if you want to enable the language for the terms and conditions. | Boolean | |
| LanguageSettings > SelectedLanguages | Specify a language for the site collection. | String collection | Valid values: Arabic Basque Bulgarian Catalan Chinese (Simplified) Chinese (Traditional) Croatian Czech Danish Dutch English Estonian Finnish French Galician German Greek Hebrew Hindi Hungarian Indonesian Italian Japanese Kazakh Korean Latvian Lithuanian Malay Norwegian (Bokmål) Polish "Portuguese (Brazil) Portuguese (Portugal) Romanian Russian Serbian (Latin) Slovak Slovenian Spanish Swedish Thai Turkish Ukrainian Vietnamese |
| LanguageSettings > DefaultLanguage | Specify a default language for the site collection. | String | |
| LanguageSettings > LanguageAssignBy | You assign the language for the site collection, or allow business users to select the language when submitting a request via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the site collection language.) ITAdminWithReadOnly (IT administrator selects the site collection language and the language is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the site collection language and the language is not shown in the request form.) |
| ClassificationSettings > SelectedClassification | Specify one site classification or multiple site classifications as the scope for new communication sites. | String collection | |
| ClassificationSettings > DefaultClassification | Specify a default site classification. | String | |
| ClassificationSettings > ClassificationAssignBy | You assign the site classification to communication sites, or allow business users to specify the site classification when submitting a request via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the site classification.) ITAdminWithReadOnly (IT administrator selects the site classification and the classification is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the site classification and the classification is not shown in the request form.) |
| SensitivitySettings > SelectedSensitivity | Specify sensitivity labels that are available for new site collections created via this service. | String collection | |
| SensitivitySettings > DefaultSensitivity | Specify a default sensitivity label. | String | |
| SensitivitySettings > SensitivityAssignBy | You assign the sensitivity label to site collections, or allow business users to specify the site collection sensitivity label when submitting a request via this service. | Enum | Valid values: BusinessUser (Business users can assign the site collection sensitivity label.) BusinessUserWithRequired (Business users are required to assign the site collection sensitivity label.) ITAdminWithReadOnly (IT administrator assigns the site collection sensitivity label, and the sensitivity label is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the site collection sensitivity label, and the sensitivity label is not shown in the request form.) |
| EnableEditRequestInTask | Set to true if you want to allow approvers to edit the request when processing a task. | Boolean | |
| EnableNotifyRequesterWhenEdited | Set to true if you want to notify the requester when the request is edited. | Boolean | |
| EditRequestEmailTemplate | Enter the name of an e-mail template that will be used to send notifications when the service request is edited. | String | |
| PrimaryContact | Enter the name of a user to be the primary site collection contact. | String | |
| PrimaryContactAssignBy | You assign the primary site collection contact or allow business users to assign the primary contact when submitting a request via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the primary site collection contact.) ITAdminWithReadOnly (IT administrator selects the primary site collection contact and the primary contact is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the primary site collection contact and the primary contact is not shown in the request form.) |
| EnableNotifyPrimaryContact | Set to true if you want to notify the primary site collection contact when the site collection is successfully created. | Boolean | |
| PrimaryContactEmailTemplate | Enter the name of an e-mail template used to send the notification e-mail to the primary site collection contact. | String | |
| SecondaryContact | Enter the name of a user to be the secondary site collection contact. | String | |
| EnableNotifySecondaryContact | Set to true if you want to notify the secondary site collection contact when the site collection is successfully created. | Boolean | |
| SecondaryContactEmailTemplate | Enter the name of an e-mail template used to send the notification e-mail to the secondary site collection contact. | String | |
| SecondaryContactAssignBy | You assign the secondary site collection contact or allow business users to assign the secondary contact when submitting a request via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the secondary site collection contact.) ITAdminWithReadOnly (IT administrator selects the secondary site collection contact and the secondary contact is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the secondary site collection contact and the secondary contact is not shown in the request form.) |
| HubSiteSettings > ConvertHubSiteType | Register the site collection as a hub site, or associate the site collection with an existing hub. | Enum | Valid values: ConvertToHubSite AssociateOneHubSite |
| HubSiteSettings > EnableHubSite | Set to true if you want to enable the hub site functionality for the site collection. | Boolean | |
| HubSiteSettings > AssociateHubSite | Enter a hub name. | String | |
| HubSiteSettings > HubSiteAssignBy | You determine whether to enable the hub site functionality for the site collection, or allow business users to determine whether to enable the hub site. | Enum | Valid values: BusinessUserWithRequired (Business users are required to configure the hub site setting.) ITAdminWithReadOnly (IT administrator configures the hub site setting and the setting is shown as read-only to business users.) ITAdminWithHide (IT administrator configures the hub site setting and the setting is not shown in the request form.) |
| MultiGeoSettings > Enabled | Set to true if you want the new site collections to be created in different geo-locations. | Boolean | |
| MultiGeoSettings > MultiGeoOption | You specify a geo location for the site collection created via this service, or assign the geo location according to the preferred data location (PDL) property of the requester or primary site collection contact. | Enum | Valid values: SpecifyLocationDirectly SpecifyLocationByRole |
| MultiGeoSettings > SelectedLocations | Enter your desired geo locations. | String collection | |
| MultiGeoSettings > DefaultLocation | Specify a default geo location, and the geo location will be shown in the request form as the default option. | String | The default geo location must be one of the geo locations above that you specified. |
| MultiGeoSettings > MultiGeoAssignBy | You specify the geo location, or allow business users to select the geo location. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the geo location.) ITAdminWithReadOnly (IT administrator selects the geo location and it is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the geo location and it is not shown in the request form.) |
| MultiGeoSettings > UserRole | Enter user roles to specify users whose preferred data location (PDL) property will be retrieved to assign the geo location. | Enum | Valid user roles: $Requester $PrimarySiteCollectionContact |
| ModernTeamSiteDesign | Specify a default site template for the new team site without a Microsoft 365 Group. Enter a site template name. | String | |
| ModernTeamSiteDesignAssignBy | You assign the site template or allow business users to assign the site template when submitting a request. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the site template.) ITAdminWithReadOnly (IT administrator selects the site template and the template is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the site template and the template is not shown in the request form.) |
| CommunicationDesign | Enter the name of a site template for the new communication site. | String | |
| CommunicationDesignAssignBy | You assign the communication site template or allow business users to assign the site template when submitting a request. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the communication site template.) ITAdminWithReadOnly (IT administrator selects the communication site template and the template is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the communication site template, and the template is not shown in the request form.) |
| SelectedPolicies | Enter the name of the site collection policies that can be applied to the site collections created by this service. | String collection | |
| DefaultPolicy | Specify a default site collection policy that you wish to apply to the site collections. Enter a site collection policy name. | String | |
| PolicyAssignBy | You assign the site collection policy to site collections created via this service, or allow business users to assign the site collection policy. | Enum | Valid values: BusinessUserWithRequired (Business users are required to select the policy.) ITAdminWithReadOnly (IT administrator selects the policy and the policy is shown as read-only to business users.) ITAdminWithHide (IT administrator selects the policy and the policy is not shown in the request form.) |
| DuplicateAction | This property value determines how to deal with the service if there is an existing service with the same name. Use the new name with a suffix automatically added to the original service name, or do not create this service during the import process. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Servicename_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the service. | String | |
| Description | Enter a description for the service. | String |
Site Collection Policy
The following table shows the properties of a site collection policy.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateSitePolicy. It indicates that the JSON file is used for the site collection policy. | Enum | |
| ServerResourceQuota | Specify the size of the server resource quota for site collections. | Int32 | |
| StorageQuota | Specify the size of the storage quota for site collections. | Int32 | The unit is GB. |
| SharingSetting > Enabled | Set to true if you want to enable external sharing on site collections with this policy applied. | Boolean | |
| SharingSetting > SharingCapabilities | Control how users invite people outside your organization to access site collection content and site content. | Enum | Valid values: Disabled ExternalUserSharingOnly ExternalUserAndGuestSharing ExistingExternalUserSharingOnly |
| SharingSetting > MembersCanShare | Set to true if you want to allow members to share the site and individual files and folders | Boolean | |
| SharingSetting > AllowMembersEditMembership | Set to true if you want to allow members to invite others to the site members group. | Boolean | |
| SharingSetting > AllowAccessRequests | Set to true if you want to allow users to request access to the site collection applied with this policy. | Boolean | |
| SharingSetting > RequestAccessEmail | Enter the e-mail addresses of the approvers who will receive the access request. | String | |
| SharingSetting > AccessRequestType | Specify who will receive access requests on the site collection. | Enum | Valid values: SpecifyEmail OwnerGroup |
| SharingSetting > AccessRequestMessage | Enter a custom message that will be shown to users who see the access request page. | String | |
| EnableDesigner | Set to true if you want to allow site owners and designers to edit the sites in the site collection using SharePoint Designer. | Boolean | |
| SiteMaxDepth | Specify the maximum depth to limit the layer for creating sites under the site collection. | Int32 | The number cannot be larger than 12. |
| SiteMaxDepthType | Specify that there is no limit for site collection maximum depth or specify the maximum depth to limit the layer. | Enum | Valid values: NoLimit SepcifiedMaxValue |
| EnableDisplayPolicyIcon | Set to true if you want to display the site collection policy icon within site collections. | Boolean | |
| PolicyIconAddress | Enter the policy icon image URL to retrieve the image. | String | |
| PolicyDetailReferenceURL | Enter the policy details reference URL for users to view details of the policy. | String | |
| AosSettings > EnablePolicyEnforcer | Set to true if you want to have AvePoint Cloud Management Policy Enforcer rules applied to the site collections. | Boolean | |
| AosSettings > PolicyEnforcerProfile | Enter the name of a Policy Enforcer profile. | String | |
| AosSettings > EnableDpm | Set to true if you want to include the site collection in an AvePoint Cloud Management Deployment Manager plan, so that the source design elements or solutions in the plan can be deployed to the site collection. | Boolean | |
| AosSettings > DpmPlan | Enter the name of a Deployment Manager plan. | String | |
| AosSettings > EnableBackup | Set to true if you want to include the site collection in a Granular Backup plan to provide data protection for site collection associated with this policy. | Boolean | |
| AosSettings > EnableAuditing | Set to true if you want to include the site collection into an Audit Controller plan in AvePoint Cloud Management Report Center to record all events of site collections associated with this policy. | Boolean | |
| AosSettings > EnableArchive | Set to true if you want to enable site collection content archival using AvePoint Cloud Archiving. | Boolean | |
| AosSettings > ArchiveProfile | Enter the name of an Archiver profile. | String | |
| AosSettings > ArchiveApprovalProcess | Enter the name of an approval process. The approver configured in the approval process will be responsible for processing the manual archive task. | String | |
| LifecycleSettings – ArchiveSettings > Profile (Configure the archiving settings if you allow business users to archive the site collection.) | Enter the name of an Archiver profile that was created in AvePoint Cloud Archiving. | String | |
| LifecycleSettings – ArchiveSettings > EnableNotify (Configure the archiving settings if you allow business users to archive the site collection.) | Set to true if you want to notify certain people when the site collection is archived. | Boolean | |
| LifecycleSettings – ArchiveSettings > NotifyUsers (Configure the archiving settings if you allow business users to archive the site collection.) | Enter usernames or user roles to specify users to be notified. | String collection | Valid user roles: $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator |
| LifecycleSettings – ArchiveSettings > NotifyEmailTemplate (Configure the archiving settings if you allow business users to archive the site collection.) | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| LifecycleSettings – ArchiveSettings > Enabled (Configure the archiving settings if you allow business users to archive the site collection.) | Set to true if you want to allow business users to archive the site collection. | Boolean | |
| LifecycleSettings – ArchiveSettings > ApprovalProcess (Configure the archiving settings if you allow business users to archive the site collection.) | Enter the name of an approval process. | String | |
| LifecycleSettings – ArchiveSettings > IsUsedDefaultProcess (Configure the archiving settings if you allow business users to archive the site collection.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – DeletionSettings > EnablePermanentlyDelete (Configure the deletion settings if you allow business users to delete the site collection.) | Set to true if you want to enable the permanent deletion of the site collection. | Boolean | |
| LifecycleSettings – DeletionSettings > EnableNotify (Configure the deletion settings if you allow business users to delete the site collection.) | Set to true if you want to notify certain people when the site collection is deleted. | Boolean | |
| LifecycleSettings – DeletionSettings > NotifyUsers (Configure the deletion settings if you allow business users to delete the site collection.) | Enter usernames or user roles to specify users to be notified. | String collection | Valid user roles: $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator |
| LifecycleSettings – DeletionSettings > NotifyEmailTemplate (Configure the deletion settings if you allow business users to delete the site collection.) | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| LifecycleSettings – DeletionSettings > Enabled (Configure the deletion settings if you allow business users to delete the site collection.) | Set to true if you want to allow business users to delete the site collection. | Boolean | |
| LifecycleSettings – DeletionSettings > ApprovalProcess (Configure the deletion settings if you allow business users to delete the site collection.) | Enter the name of an approval process. | String | |
| LifecycleSettings – DeletionSettings > IsUsedDefaultProcess (Configure the deletion settings if you allow business users to delete the site collection.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – ExtensionSettings > Type (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | Specify the methods to set the limit on the site collection lease extension. | TemplatePolicyExtensionType | |
| LifecycleSettings – ExtensionSettings > Duration (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | The extension must be a specific period of time. Enter a number for the amount of time. | Int32 | |
| LifecycleSettings – ExtensionSettings > DurationType (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| LifecycleSettings – ExtensionSettings > ExtendBasedOnPoint (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | Define whether to use the approved date of the site collection lease extension request as the new lease start date. | Enum | Valid values: None ExpiredTime ApprovaledTime |
| LifecycleSettings – ExtensionSettings > Enabled (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | Set to true if you want to allow business users to extend the site collection lease period. | Boolean | |
| LifecycleSettings – ExtensionSettings > ApprovalProcess (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | Enter the name of an approval process. | String | |
| LifecycleSettings – ExtensionSettings > IsUsedDefaultProcess (Configure the extension settings if you want to allow business users to request to extend the lease of a site collection.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – ChangePolicySettings > IsDefineChangeToPolicies (Configure the change policy settings if you allow business users to change the site collection policy.) | Set to true if you want to show list of available policies for selection to limit what policies are presented to users in the Site Collection Lifecycle Management - Change Site Collection Policy service. | Boolean | |
| LifecycleSettings – ChangePolicySettings > SelectedPolicies (Configure the change policy settings if you allow business users to change the site collection policy.) | Configure policies that are available to be selected. | String collection | |
| LifecycleSettings – ChangePolicySettings > Enabled (Configure the change policy settings if you allow business users to change the site collection policy.) | Set to true if you want to allow business users to change the site collection policy. | Boolean | |
| LifecycleSettings – ChangePolicySettings > ApprovalProcess (Configure the change policy settings if you allow business users to change the site collection policy.) | Enter the name of an approval process. | String | |
| LifecycleSettings – ChangePolicySettings > IsUsedDefaultProcess (Configure the change policy settings if you allow business users to change the site collection policy.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – UnlockSettings > Enabled (Configure the settings if you allow business users to unlock the locked site collection.) | Set to true if you want to allow business users to unlock the locked site collection. | Boolean | |
| LifecycleSettings – UnlockSettings > ApprovalProcess (Configure the settings if you allow business users to unlock the locked site collection.) | Enter the name of an approval process. | String | |
| LifecycleSettings – UnlockSettings > IsUsedDefaultProcess (Configure the settings if you allow business users to unlock the locked site collection.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – LockSettings > LockType (Configure the settings if you allow business users to lock the site collection.) | Specify the site collection locking types. | TemplateSiteLockType | Valid values: NoAccess ReadOnly NoAccessAndReadOnly |
| LifecycleSettings – LockSettings > EnableNotify (Configure the settings if you allow business users to lock the site collection.) | Set to true if you notify certain people when the site collection is locked. | Boolean | |
| LifecycleSettings – LockSettings > NotifyUsers (Configure the settings if you allow business users to lock the site collection.) | Specify users that will be notified. | String collection | |
| LifecycleSettings – LockSettings > NotifyEmailTemplate (Configure the settings if you allow business users to lock the site collection.) | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| LifecycleSettings – LockSettings > Enabled (Configure the settings if you allow business users to lock the site collection.) | Set to true if you want to allow business users to lock the site collection. | Boolean | |
| LifecycleSettings – LockSettings > ApprovalProcess (Configure the settings if you allow business users to lock the site collection.) | Enter the name of an approval process. | String | |
| LifecycleSettings – LockSettings > IsUsedDefaultProcess (Configure the settings if you allow business users to lock the site collection.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – ChangeQuotaSettings > Option (Configure the settings if you allow business users to change the site collection quota.) | Specify the quota change option to set limit for the quota change. | Enum | Valid values: Any (Allows business users to increase or decrease site collection quota, and the change cannot exceed the size defined in the Size property.) Specified (Allows business users to request to change site collection quota to any available size.) |
| LifecycleSettings – ChangeQuotaSettings > Size (Configure the settings if you allow business users to change the site collection quota.) | Specify the size to limit the site quota change. | Int32 | The unit is GB. |
| LifecycleSettings – ChangeQuotaSettings > Enabled (Configure the settings if you allow business users to change the site collection quota.) | Set to true if you want to allow business users to change the site collection quota. | Boolean | |
| LifecycleSettings – ChangeQuotaSettings > ApprovalProcess (Configure the settings if you allow business users to change the site collection quota.) | Enter the name of an approval process. | String | |
| LifecycleSettings – ChangeQuotaSettings > IsUsedDefaultProcess (Configure the settings if you allow business users to change the site collection quota.) | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings – ChangeQuotaSettings > DefaultApprovalProcess (Configure the settings if you allow business users to change the site collection quota.) | Enter the name of an approval process that will be used as the default approval process. | String | |
| InactivityThresholdSettings > Enabled | Set to true if you want to enable the site collection inactivity threshold. | Boolean | |
| InactivityThresholdSettings > Duration | Specify the amount of time for the inactivity threshold. | Int32 | |
| InactivityThresholdSettings > DurationType | Specify the unit of time for the inactivity threshold. | Enum | Valid values: Day Week Month Year |
| InactivityThresholdSettings > ApprovalProcess | Enter the name of an approval process. The approver configured in the approval process will be responsible for the site collection inactivity task. | String | |
| InactivityThresholdSettings > EnableAutoLock | Set to true if you want to enable the automated site collection locking. The site collection deletion task will be automatically generated if the inactivity threshold task is not completed within the specified amount of time. | Boolean | |
| InactivityThresholdSettings > AutoLockProfile | Enter the name of a site collection automated locking profile. | String | |
| LeaseThresholdSettings > EnableNotify | Set to true if you want to notify the approver when the site collection lease expires. | Boolean | |
| LeaseThresholdSettings > NotifyEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| LeaseThresholdSettings > Enabled | Set to true if you want to enable a lease period for the site collection. | Boolean | |
| LeaseThresholdSettings > Duration | Specify a number as the amount of time for the site collection lease. | Int32 | |
| LeaseThresholdSettings > DurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| LeaseThresholdSettings > ApprovalProcess | Enter the name of an approval process. The approver configured in the approval process will be responsible for the site collection site collection lease expiration task | String | |
| LeaseThresholdSettings > EnableAutoLock | Set to true if you want to enable the automated site collection locking. The site collection deletion task will be automatically generated if the lease expiration task is not completed within the specified amount of time. | Boolean | |
| LeaseThresholdSettings > AutoLockProfile | Enter the name of a site collection automated locking profile. | String | |
| DeactiveContactElectionSettings > Enabled | Set to true if you want to enable automated ownership election process to start the ownership election process when either of the site collection contacts is deactivated. | Boolean | |
| DeactiveContactElectionSettings > EnableOnlyOtherContactElection | Set to true if you only want to generate the election task for the other contact when one contact account is deactivated. | Boolean | |
| DeactiveContactElectionSettings > ExcludeUsers | Enter usernames to specify users that will be excluded during the election process. | String collection | |
| DeactiveContactElectionSettings > EnableNotifyTask | Set to true if you want to notify the user when the election task is assigned. | Boolean | |
| DeactiveContactElectionSettings > NotifyTaskEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| DeactiveContactElectionSettings > EnableNotifyPrimaryContact | Set to true if you want to notify the primary contact when the site collection is assigned. | Boolean | |
| DeactiveContactElectionSettings > NotifyPrimaryContactEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| DeactiveContactElectionSettings > EnableNotifySecondaryContact | Set to true if you want to notify the secondary contact when the site collection is assigned. | Boolean | |
| DeactiveContactElectionSettings > NotifySecondaryContactEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| DeactiveContactElectionSettings > Duration | Specify a number as the duration for each election stage. | Int32 | |
| DeactiveContactElectionSettings > DurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week |
| DeactiveContactElectionSettings > EnableRemind | Set to true if you want to remind the nominated user before each nomination task expires. | Boolean | |
| DeactiveContactElectionSettings > ReminderProfile | Enter the name of a reminder profile. | String | |
| QuotaThresholdSettings > Enabled | Set to true if you want to enable the site collection quota threshold. | Boolean | |
| QuotaThresholdSettings > Percentage | Enter a number to specify a percentage as the quota threshold. | Int32 | |
| QuotaThresholdSettings > NotifyUsers | Specify users that will be notified when the site collection's storage reaches the specified percentage of the allocated quota. | String collection | Valid user roles: $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator |
| QuotaThresholdSettings > QuotaThresholdNotifyEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| EnableRenewal | Set to true if you want to enable the renewal process for the site collection applied with the policy. | Boolean | |
| RenewalProfile | Enter the name of a renewal profile. | String | |
| SkipNotGAOData | This property is for the profiles that are not created in AvePoint Cloud Governance. Set to true if you want to disable related settings when the specified profiles cannot be found. | Boolean | |
| Category | Enter the name of a category that is used to organize the site collection policy. | String | |
| DuplicateAction | This property value determines how to deal with the policy if there is an existing policy with the same name. Use the new name with a suffix automatically added to the original policy name, or do not create the policy during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the policy with the same name, the existing policy with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Policyname_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the site collection policy. | String | |
| Description | Enter a description for the site collection policy. | String |
Approval Process
The following table shows the properties of an approval process.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateApprovalProcess. It indicates that the JSON file is used for the approval process. | Enum | |
| Category | Enter the name of a category that is used to organize the approval process. | String | |
| CC | Enter usernames, group names, or user roles. They will be notified when the service request is completed without assigning tasks to them. | String collection | Valid user roles: $ManagerOfApprover $AdministratorContact $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator $ManagerOfRequester |
| BCC | Enter usernames, group names, or user roles. They will be notified when the service request is completed without assigning tasks to them. | String collection | Valid user roles: $ManagerOfApprover $AdministratorContact $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator $ManagerOfRequester $ApproversAndAllAssignees |
| StageOneSettings > ApproveOrder | Specify the order in which the approval tasks are assigned. | Enum | Valid values: Serial Parallel |
| StageOneSettings > Approvers | Enter usernames or certain user roles to specify users as approvers. | String collection | Valid user roles: $Requester $ManagerofRequester $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator $ServiceMetadata("{MetadataName}") |
| StageOneSettings > Description | Enter an optional description for the first approval stage. | String | |
| StageOneSettings > Name | Enter a name for the first approval stage. | String | |
| StageOneSettings > AllowAutocrat | Set to true if you allow the approval stage to complete when one approver approves. | Boolean | |
| StageOneSettings > AllowReassign | Set to true if you allow approvers to reassign tasks to others. | Boolean | |
| StageOneSettings – DurationSetting > EnableDuration (Duration and escalation settings for the first approval stage.) | Set to true if you want to enable duration for the approval process. | Boolean | |
| StageOneSettings – DurationSetting > Reassignee (Duration and escalation settings for the first approval stage.) | Enter a username or user role to specify the user that the task will be re-assigned to. | String | Valid user role: $ManagerOfApprover |
| StageOneSettings – DurationSetting > EscalationUsers (Duration and escalation settings for the first approval stage.) | Enter usernames or a user role to specify users that will be notified. | String collection | Valid user role: $ManagerOfApprover |
| StageOneSettings – DurationSetting > EnableDurationReminder (Duration and escalation settings for the first approval stage.) | Set to true if you want to enable reminder before the escalation. | Boolean | |
| StageOneSettings – DurationSetting > Duration (Duration and escalation settings for the first approval stage.) | Enter a number to specify the amount of time for the duration. | Int32 | |
| StageOneSettings – DurationSetting > ReassignEmailTemplate (Duration and escalation settings for the first approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail to the approver when the task is re-assigned to them. | String | |
| StageOneSettings – DurationSetting > AutoRejectEmailTemplate (Duration and escalation settings for the first approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail when the approval task is automatically rejected. | String | |
| StageOneSettings – DurationSetting > NotifyEmailTemplate (Duration and escalation settings for the first approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail when the task is escalated. | String | |
| StageOneSettings – DurationSetting > DurationReminderProfile (Duration and escalation settings for the first approval stage.) | Enter the name of a reminder profile. | String | |
| StageOneSettings – DurationSetting > DurationType (Duration and escalation settings for the first approval stage.) | Enter a duration type. | Enum | Valid values: Day Week |
| StageOneSettings – DurationSetting > EscalationType (Duration and escalation settings for the first approval stage.) | Specify an escalation type. | Enum | Valid values: Notify ReAssignTo AutoReject |
| StageOneSettings – EmailSetting > EnableNotifyApproverWhenAssigned (E-mail notification settings for the first approval stage.) | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageOneSettings – EmailSetting > NotifyApproverEmailTemplate (E-mail notification settings for the first approval stage.) | Enter the name of an e-mail template that will be used to notify the approver when the task is assigned. | String | |
| StageOneSettings – EmailSetting > EnableNotifyRequesterWhenApproved (E-mail notification settings for the first approval stage.) | Set to true if you want to notify the requester when the request is approved. | Boolean | |
| StageOneSettings – EmailSetting > NotifyRequesterApprovedEmailTemplate (E-mail notification settings for the first approval stage.) | Enter the name of an e-mail template that will be used to notify the requester when the request is approved. | String | |
| StageOneSettings – EmailSetting > EnableNotifyRequesterWhenRejected (E-mail notification settings for the first approval stage.) | Set to true if you want to notify the requester when the request is rejected. | Boolean | |
| StageOneSettings – EmailSetting > NotifyRequesterRejectedEmailTemplate (E-mail notification settings for the first approval stage.) | Enter the name of an e-mail template that will be used to notify the requester when the request is rejected. | String | |
| StageOneSettings – EmailSetting > EnableNotifyApproverWhenCancelled (E-mail notification settings for the first approval stage.) | Set to true if you want to notify the approver and requester when the request is canceled. | Boolean | |
| StageOneSettings – EmailSetting > NotifyApproverCancelledEmailTemplate (E-mail notification settings for the first approval stage.) | Enter the name of an e-mail template that will be used to notify the requester and approver when the request is canceled. | String | |
| StageOneSettings – EmailSetting > EnableNotifyApproverWhenRejected (E-mail notification settings for the first approval stage.) | Set to true if you want to notify all previous approvers when the request is rejected. | Boolean | |
| StageOneSettings – EmailSetting > NotifyApproverRejectedEmailTemplate (E-mail notification settings for the first approval stage.) | Enter the name of an e-mail template that will be used to notify all previous approvers when the request is rejected. | String | |
| StageTwoSettings > ApproveOrder | Specify the order in which the approval tasks are assigned. | Enum | Valid values: Serial Parallel |
| StageTwoSettings > Approvers | Enter usernames or certain user roles to specify users as approvers. | String collection | Valid user roles: $Requester $ManagerofRequester $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator $ManagerOfPreviousStageApprover $ServiceMetadata("{MetadataName}") |
| StageTwoSettings > Description | Enter an optional description for the second approval stage. | String | |
| StageTwoSettings > Name | Enter a name for the second approval stage. | String | |
| StageTwoSettings > AllowAutocrat | Set to true if you allow the approval stage to complete when one approver approves. | Boolean | |
| StageTwoSettings > AllowReassign | Set to true if you allow approvers to reassign tasks to others. | Boolean | |
| StageTwoSettings – DurationSetting > EnableDuration (Duration and escalation settings for the second approval stage.) | Set to true if you want to enable duration for the approval process. | Boolean | |
| StageTwoSettings – DurationSetting > Reassignee (Duration and escalation settings for the second approval stage.) | Enter a username or certain user role to specify the user that the task will be re-assigned to. | String | Valid user role: $ManagerOfApprover |
| StageTwoSettings – DurationSetting > EscalationUsers (Duration and escalation settings for the second approval stage.) | Enter usernames or a user role to specify users that will be notified. | String collection | Valid user role: $ManagerOfApprover |
| StageTwoSettings – DurationSetting > EnableDurationReminder (Duration and escalation settings for the second approval stage.) | Set to true if you want to enable reminder before the escalation. | Boolean | |
| StageTwoSettings – DurationSetting > Duration (Duration and escalation settings for the second approval stage.) | Enter a number to specify the amount of time for the duration. | Int32 | |
| StageTwoSettings – DurationSetting > ReassignEmailTemplate (Duration and escalation settings for the second approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail to the approver when the task is re-assigned to them. | String | |
| StageTwoSettings – DurationSetting > AutoRejectEmailTemplate (Duration and escalation settings for the second approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail when the approval task is automatically rejected. | String | |
| StageTwoSettings – DurationSetting > NotifyEmailTemplate (Duration and escalation settings for the second approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail when the task is escalated. | String | |
| StageTwoSettings – DurationSetting > DurationReminderProfile (Duration and escalation settings for the second approval stage.) | Enter the name of a reminder profile. | String | |
| StageTwoSettings – DurationSetting > DurationType (Duration and escalation settings for the second approval stage.) | Enter a duration type. | Enum | Valid values: Day Week |
| StageTwoSettings – DurationSetting > EscalationType (Duration and escalation settings for the second approval stage.) | Specify an escalation type. | Enum | Valid values: Notify ReAssignTo AutoReject |
| StageTwoSettings – EmailSetting > EnableNotifyApproverWhenAssigned (E-mail notification settings for the second approval stage.) | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageTwoSettings – EmailSetting > NotifyApproverEmailTemplate (E-mail notification settings for the second approval stage.) | Enter the name of an e-mail template that will be used to notify the approver when the task is assigned. | String | |
| StageTwoSettings – EmailSetting > EnableNotifyRequesterWhenApproved (E-mail notification settings for the second approval stage.) | Set to true if you want to notify the requester when the request is approved. | Boolean | |
| StageTwoSettings – EmailSetting > NotifyRequesterApprovedEmailTemplate (E-mail notification settings for the second approval stage.) | Enter the name of an e-mail template that will be used to notify the requester when the request is approved. | String | |
| StageTwoSettings – EmailSetting > EnableNotifyRequesterWhenRejected (E-mail notification settings for the second approval stage.) | Set to true if you want to notify the requester when the request is rejected. | Boolean | |
| StageTwoSettings – EmailSetting > NotifyRequesterRejectedEmailTemplate (E-mail notification settings for the second approval stage.) | Enter the name of an e-mail template that will be used to notify the requester when the request is rejected. | String | |
| StageTwoSettings – EmailSetting > EnableNotifyApproverWhenCancelled (E-mail notification settings for the second approval stage.) | Set to true if you want to notify the approver and requester when the request is canceled. | Boolean | |
| StageTwoSettings – EmailSetting > NotifyApproverCancelledEmailTemplate (E-mail notification settings for the second approval stage.) | Enter the name of an e-mail template that will be used to notify the requester and approver when the request is canceled. | String | |
| StageTwoSettings – EmailSetting > EnableNotifyApproverWhenRejected (E-mail notification settings for the second approval stage.) | Set to true if you want to notify all previous approvers when the request is rejected. | Boolean | |
| StageTwoSettings – EmailSetting > NotifyApproverRejectedEmailTemplate (E-mail notification settings for the second approval stage.) | Enter the name of an e-mail template that will be used to notify all previous approvers when the request is rejected. | String | |
| StageTwoSettings – EmailSetting > EnableNotifyApproverWhenAssigned (E-mail notification settings for the second approval stage.) | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageThreeSettings > ApproveOrder | Specify the order in which the approval tasks are assigned. | Enum | Valid values: Serial Parallel |
| StageThreeSettings > Approvers | Enter usernames or certain user roles to specify users as approvers. | String collection | Valid user roles: $Requester $ManagerofRequester $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator $ManagerOfPreviousStageApprover $ServiceMetadata("{MetadataName}") |
| StageThreeSettings > Description | Enter an optional description for the third approval stage. | String | |
| StageThreeSettings > Name | Enter a name for the third approval stage. | String | |
| StageThreeSettings > AllowAutocrat | Set to true if you allow the approval stage to complete when one approver approves. | Boolean | |
| StageThreeSettings > AllowReassign | Set to true if you allow approvers to reassign tasks to others. | Boolean | |
| StageThreeSettings – DurationSetting > EnableDuration (Duration and escalation settings for the third approval stage.) | Set to true if you want to enable duration for the approval process. | Boolean | |
| StageThreeSettings – DurationSetting > Reassignee (Duration and escalation settings for the third approval stage.) | Enter a usernames or user role to specify the user that the task will be re-assigned to. | String | Valid user role: $ManagerOfApprover |
| StageThreeSettings – DurationSetting > EscalationUsers (Duration and escalation settings for the third approval stage.) | Enter usernames or a user role to specify users that will be notified. | String collection | Valid user role: $ManagerOfApprover |
| StageThreeSettings – DurationSetting > EnableDurationReminder (Duration and escalation settings for the third approval stage.) | Set to true if you want to enable reminder before the escalation. | Boolean | |
| StageThreeSettings – DurationSetting > Duration (Duration and escalation settings for the third approval stage.) | Enter a number to specify the amount of time for the duration. | Int32 | |
| StageThreeSettings – DurationSetting > ReassignEmailTemplate (Duration and escalation settings for the third approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail to the approver when the task is re-assigned to them. | String | |
| StageThreeSettings – DurationSetting > AutoRejectEmailTemplate (Duration and escalation settings for the third approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail when the approval task is automatically rejected. | String | |
| StageThreeSettings – DurationSetting > NotifyEmailTemplate (Duration and escalation settings for the third approval stage.) | Enter the name of an e-mail template that will be used to send the notification e-mail when the task is escalated. | String | |
| StageThreeSettings – DurationSetting > DurationReminderProfile (Duration and escalation settings for the third approval stage.) | Enter the name of a reminder profile. | String | |
| StageThreeSettings – DurationSetting > DurationType (Duration and escalation settings for the third approval stage.) | Enter a duration type. | Enum | Valid values: Day Week |
| StageThreeSettings – DurationSetting > EscalationType (Duration and escalation settings for the third approval stage.) | Specify an escalation type. | Enum | Valid values: Notify ReAssignTo AutoReject |
| StageThreeSettings – EmailSetting > EnableNotifyApproverWhenAssigned (E-mail notification settings for the third approval stage.) | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageThreeSettings – EmailSetting > NotifyApproverEmailTemplate (E-mail notification settings for the third approval stage.) | Enter the name of an e-mail template that will be used to notify the approver when the task is assigned. | String | |
| StageThreeSettings – EmailSetting > EnableNotifyRequesterWhenApproved (E-mail notification settings for the third approval stage.) | Set to true if you want to notify the requester when the request is approved. | Boolean | |
| StageThreeSettings – EmailSetting > NotifyRequesterApprovedEmailTemplate (E-mail notification settings for the third approval stage.) | Enter the name of an e-mail template that will be used to notify the requester when the request is approved. | String | |
| StageThreeSettings – EmailSetting > EnableNotifyRequesterWhenRejected (E-mail notification settings for the third approval stage.) | Set to true if you want to notify the requester when the request is rejected. | Boolean | |
| StageThreeSettings – EmailSetting > NotifyRequesterRejectedEmailTemplate (E-mail notification settings for the third approval stage.) | Enter the name of an e-mail template that will be used to notify the requester when the request is rejected. | String | |
| StageThreeSettings – EmailSetting > EnableNotifyApproverWhenCancelled (E-mail notification settings for the third approval stage.) | Set to true if you want to notify the approver and requester when the request is canceled. | Boolean | |
| StageThreeSettings – EmailSetting > NotifyApproverCancelledEmailTemplate (E-mail notification settings for the third approval stage.) | Enter the name of an e-mail template that will be used to notify the requester and approver when the request is canceled. | String | |
| StageThreeSettings – EmailSetting > EnableNotifyApproverWhenRejected (E-mail notification settings for the third approval stage.) | Set to true if you want to notify all previous approvers when the request is rejected. | Boolean | |
| StageThreeSettings – EmailSetting > NotifyApproverRejectedEmailTemplate (E-mail notification settings for the third approval stage.) | Enter the name of an e-mail template that will be used to notify all previous approvers when the request is rejected. | String | |
| StageSettings > EnableAutoApproveWhenRequesterIsApprover | Set to true if you want to automatically approve the request when the requester and the approver are the same person. | Boolean | |
| StageSettings > EnableAutoApproval | Set to true if you want to enable automatic approval under certain conditions. | Boolean | |
| StageSettings > EnableAutoApproveWhenRequesterInAutoApproveGroup | Set to true if you want to automatically approve the request when the requester is a member of a specific group. | Boolean | |
| StageSettings > AutoApproveGroup | Enter one or more group names. | String collection | |
| StageSettings > StageCount | Enter a number to specify the approval stages. | Int32 | Valid values: 0 1 2 3 |
| CompletionEmailTemplate > CompletionEmailTemplate | Enter the name of an e-mail template that will be used to send the request completion notification e-mail. | String | |
| DuplicateAction > DuplicateAction | This property value determines how to deal with the approval process if there is an existing approval process with the same name. Use the new name with a suffix automatically added to the original approval process name, or do not create the approval process during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the approval process with the same name, the existing approval process with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Approvalprocessname_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name > Name | Enter a name for this approval process. | String | |
| Description > Description | Enter a description for this approval process. | String |
Site Collection Renewal Profile
The following table shows the properties of a site collection renewal profile.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateSiteRenewalProfile. It indicates that the JSON file is used for the site collection renewal profile. | Enum | |
| AutoLockSettings > EscalationType | Specify the site collection locking type. | Enum | Valid values: NoAccess ReadOnly |
| AutoLockSettings > Enabled | Set to true if you want to enable the automated site collection locking when the renewal task is overdue. | Boolean | |
| AutoLockSettings > Interval | Specify a number as the amount of time. The site collection will be automatically locked if the renewal process is not completed within the designated amount of time. | Int32 | |
| AutoLockSettings > IntervalType | Specify the unit of time. | Enum | Valid values: Day Week |
| AutoLockSettings > EnableRemind | Set to true if you want to notify the administrator contact of the renewal process before the site collection is locked. | Boolean | |
| AutoLockSettings > ReminderProfile | Enter the name of a reminder profile. | String | |
| AutoLockSettings > EnableNotification | Set to true if you want to notify certain people when the site collection is locked. | Boolean | |
| AutoLockSettings > NotifyUsers | Specify users to be notified. | String collection | |
| AutoLockSettings > EmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| EnableExcludePermissions | This is for permission renewal. Set to true if you want to exclude specified permission levels from the renewal task. | Boolean | |
| ExcludedPermissions | Enter available permission levels to be excluded. | String collection | |
| EnableHideExcludePermissionObject | Set to true if you want to hide the objects with the excluded permissions from the renewal task. | Boolean | |
| Category | Enter the name of a category that is used to organize the renewal profile. | String | |
| AdminContact | Specify an administrator contact who is responsible for the successful completion of the renewal process. | String | |
| CustomizeMessageList > CustomizedMessageValue | Enter a message that will be displayed to the renewal task assignee, asking whether or not the login user is the correct person to perform the renewal action. | String | |
| CustomizeMessageList > isEnabled | Set to true if you want to enable the language for the custom message. | Boolean | |
| CustomizeMessageList > Language | Define the language for the custom message shown to the renewal process assignee. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| DefaultLanguage | Specify a default language for the custom message shown to the renewal process assignee. Note that only the language whose property isEnabled is set to true can be set as the default language. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| ErrorTaskNotificationEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail when the renewal task encounters any errors. | String | |
| OverDueNotificationEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail when the renewal process is overdue. | String | |
| DurationEscalationSettings > Sequence | Enter user roles or group names to assign users or groups as the renewal task assignee | String collection | Valid user roles: $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimarySiteCollectionAdministrator $AdditionalSiteCollectionAdministrators $ManagerOfPrimarySiteCollectionContact $ManagerOfSecondarySiteCollectionContact |
| DurationEscalationSettings > EnableReassign | Set to true if you allow task assignees to reassign tasks to other users. | Boolean | |
| DurationEscalationSettings > EnableSkipProcess | Set to true if you allow task assignees to state they are not responsible and are unsure who is responsible to complete the renewal process. | Boolean | |
| DurationEscalationSettings > NewTaskNotificationEmailTemplate | Enter the name of an e-mail template that will be used to notify the assignee of the renewal task. | String | |
| DurationEscalationSettings > Duration | Specify a number as the amount of time for the duration for each process. | Int32 | |
| DurationEscalationSettings > AssigneeOrder | Specify the renewal order for all renewal task assignees. | Enum | Valid values: 0 (The renewal task assignees must complete the task one after another.) 1 (The renewal task will be assigned to all task assignees at the same time.) |
| DurationEscalationSettings > DurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week |
| RecurrenceSettings > Weekly > Interval | Enter a number for the week interval to configure the weekly recurrent renewal process. | Int32 | For example, enter 3 to set the interval as every 3 weeks. |
| RecurrenceSettings > Weekly > DayofWeek | Specify a specific day within a week to configure the weekly renewal process | Enum | Valid values: Sunday Monday Tuesday Wednesday Thursday Friday Saturday |
| RecurrenceSettings > Daily > Interval | Enter a number for the day interval to configure the day interval. | Int32 | For example, enter 90 to set the interval as every 90 days. |
| RecurrenceSettings > Monthly > Interval | Enter a number for the monthly interval to configure the monthly recurrent renewal process. | Int32 | For example, enter 3 to set the interval as every 3 months. |
| RecurrenceSettings > Monthly > DayOfMonth | Specify a specific day within a month. | Int32 | Enter an integer between 1 and 28 to specify a specific date in a month, or enter 32 to specify the last day of a month. |
| RecurrenceSettings > OrderWeekInMonth > OrderOfWeek | Specify the order of the day. | Enum | Valid values: First Second Third Forth Last For example, the First Sunday of every 3 months. |
| RecurrenceSettings > OrderWeekInMonth > OrderWeekdayInMonth | Specify a specific day within a week. | Enum | Valid values: Sunday Monday Tuesday Wednesday Thursday Friday Saturday |
| RecurrenceSettings > OrderWeekInMonth > OrderWeekMonthInterval | Enter a number for the month interval. | Int32 | Enter 3 to set the interval as every 3 months. |
| RecurrenceSettings > ScheduleType | Specify the recurrence of the renewal process as Daily, Weekly, or Monthly. | Enum | Valid values: Day Week Month OrderWeekInMonth |
| RecurrenceSettings > SpecifyFirstTaskGenerateTime | Set to true if you want to specify the time to generate the first renewal task. | Boolean | |
| RecurrenceSettings > FirstGeneratedTime | Specify a specific date and time in UTC time as the first task generation time. | DateTime | For example, midnight UTC on January 1, 2020 is 2020-01-01 00:00:00. |
| RecurrenceSettings > RenewalScheduleType | Specify a method to configure the renewal schedule. | Enum | Valid values: Periodically (Configure a periodic renewal schedule.) ManualDate (Manually specify each renewal task generation time.) |
| RecurrenceSettings > ManualScheduleDates | Specify the renewal task generation time. | String collection | For example, 12-25_14:49. |
| Metadatas > Name | Enter the metadata name. | String | |
| Metadatas > AssignBy | You set a default value for the metadata or allow business users to assign the metadata value. | Enum | Valid values: BusinessUser (Business users can define the metadata value.) BusinessUserWithRequired (Business users are required to define the metadata value.) ITAdminWithReadOnly (IT administrator defines the metadata value and the value is shown as read-only to business users.) ITAdminWithHide (IT administrator defines the metadata value and the value is not shown in the request form.) |
| SingleLineOrMultipleLineTypeValue > Value | Enter a default value for the metadata or enter multiple lines of text as the metadata value. | String | |
| LinkTypeValue > Title | Enter the desired text to be the hyperlink title. | String | |
| LinkTypeValue > Address | Enter the address of the hyperlink. | String | |
| ChoiceTypeValue > Values | Enter the choices you wish to provide. | String collection | |
| UserProfileTypeValue > Value | Enter a username to get the user's property value from the user profile. | String | |
| AzureAdTypeValue > Value | Enter a username to get the user's property value from Microsoft Entra. | String | |
| UserTypeValue > Values | Enter a username to get the user property value from. | String collection | |
| ManagedTypeValue > Values | Enter terms that have been configured in your SharePoint term store. | String collection | |
| YesOrNoTypeValue > Value | Specify a default value for the metadata, true or false. | Boolean | |
| YesOrNoTypeValue > DefaultTermLanguage | Specify a default display language for the terms and conditions. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| YesOrNoTypeValue > EnableTerms | Set to true if you want to enable the desired terms and conditions. Note that if you enable the terms and conditions agreement, only Yes can be the default value. | Boolean | |
| YesOrNoTypeValue > TermsAndConditions > Language | Specify a language for the terms and conditions. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| YesOrNoTypeValue > TermsAndConditions > Term | Define the terms and conditions. | String | |
| YesOrNoTypeValue > TermsAndConditions > TrueValue | Enter your preferred value to replace Yes. | String | |
| YesOrNoTypeValue > TermsAndConditions > FalseValue | Enter your preferred value to replace No. | String | |
| YesOrNoTypeValue > TermsAndConditions > IsEnableCustomValue | Set to true if you change default terms and conditions metadata to your preferred values. | Boolean | |
| YesOrNoTypeValue > TermsAndConditions > IsEnabled | Set to true if you want to enable the language for the terms and conditions. | Boolean | |
| EnableArchival | Set to true if you allow the renewal task assignee to archive the site collection. | Boolean | |
| EnableDeletion | Set to true if you allow the renewal task assignee to delete the site collection. | Boolean | |
| EnableContactRenewal | Set to true if you allow renewal task assignees to review and modify primary site collection contact and secondary site collection contact. | Boolean | |
| EnableNotifyNewContact | Set to true if you want to notify the newly assigned contacts when task assignees select them as the new contacts. | Boolean | |
| NotifyNewContactEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| EnableMetadataRenewal | Set to true if you allow renewal task assignees to review and modify values of site collection metadata. | Boolean | |
| EnablePermissionRenewal | Set to true if you allow renewal task assignees to review and modify user and SharePoint group permissions to site collection content. | Boolean | |
| EnableOnlyExternalUsers | Set to true if you allow renewal task assignees to only renew external users. | Boolean | |
| EnableAddUsersToSPGroup | Set to true if you allow renewal task assignees to add users to SharePoint groups during the renewal process. | Boolean | |
| EnableSharingLinksRenewal | Set to true if you allow renewal task assignees to renew sharing links. | Boolean | |
| EnableRemoveGuestAccess | Set to true if you want to enable the recommended action for renewal task assignees to remove all direct guest user access to high risk content. | Boolean | |
| EnableRemoveSharingLinks | Set to true if you want to enable the recommended action for renewal task assignees to remove all sharing links with external user access. | Boolean | |
| DuplicateAction | This property value determines how to deal with the profile if there is an existing profile with the same name. Use the new name with a suffix automatically added to the original profile name, or do not create the profile during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the profile with the same name, the existing profile with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Profilename_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the site collection renewal profile. | String | |
| Description | Enter the description of the site collection renewal profile. | String |
Automated Locking Profile
The following table shows the properties of a site collection automated locking profile.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateAutoLockProfile. It indicates that the JSON file is used for the site collection automated locking profile. | Enum | |
| LockTaskDuration | Specify a number as the amount of time for the duration. | Int32 | |
| LockTaskDurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| LockType | Specify a site collection automated locking type. | Enum | Valid values: NoAccess ReadOnly |
| EnableLockTaskRemind | Set to true if you want to enable reminder before the site collection is locked. | Boolean | |
| LockTaskReminderProfile | Enter the name of a reminder profile. | String | |
| EnableLockNotify | Set to true if you want to notify people when the site collection is locked. | Boolean | |
| LockNotifyContacts | Specify users that will be notified when the site collection is locked. | String collection | |
| AdditionalAction > Enabled | Set to true if you want to start an additional site collection lifecycle action to escalate. | Boolean | |
| AdditionalAction > AdditionalActionDuration | Specify a number as the amount of time for the duration. After the site collection is locked for the specified amount of time, the additional site collection lifecycle action task will be generated. | Int32 | |
| AdditionalAction > AdditionalActionDurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| AdditionalAction > AdditionalActionType | Specify a lifecycle action as the additional lifecycle action. | Enum | Valid values: Delete Archive |
| AdditionalAction > IsUseUniqueApprovalProcess | Set to true if you want to use a unique approval process for this automated action. | Boolean | |
| AdditionalAction > UniqueApprovalProcess | Enter the name of an approval process. | String | |
| AdditionalAction > EnableAdditionalTaskRemind | Set to true if you want to enable reminder for the approvers about the site collection escalation before generating the lifecycle action task. | Boolean | |
| AdditionalAction > AdditionalActionTaskReminderProfile | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| LockNotifyEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail when the site collection is locked. | String | |
| DuplicateAction | This property value determines how to deal with the profile if there is an existing profile with the same name. Use the new name with a suffix automatically added to the original profile name, or do not create the profile during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the profile with the same name, the existing profile with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Profilename_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the site collection automated locking profile. | String | |
| Description | Enter a description for the site collection automated locking profile. | String |
Reminder Profile
The following table shows the properties of a reminder profile.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateReminderProfile. It indicates that the JSON file is used for the reminder profile. | Enum | |
| EmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| NotifyAdvanceInterval | Enter a number to define when to send the notification e-mail before the task expires. | Int32 | |
| NotifyAdvanceIntervalType | Enter a duration type as the unit of the duration. | Enum | Valid values: Day Week Month |
| EnableRecurrentRemind | Set to true if you want to enable recurrent reminder to re-send the notification e-mail in schedule. | Boolean | |
| RecurrentReminderInterval | Enter a number to define the recurrent reminder schedule. | Int32 | The unit of time is day. |
| DuplicateAction | This property value determines how to deal with the profile if there is an existing profile with the same name. Use the new name with a suffix automatically added to the original profile name, or do not create the profile during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the profile with the same name, the existing profile with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Profilename_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| CC | Specify users or groups (Microsoft 365 Groups, distribution groups, or mail-enabled security groups) who will receive a copy of the reminder e-mail before the task is overdue. | String collection | Local users or guest users are not allowed to be specified. |
| Name | Enter a name for this reminder profile. | String | |
| Description | Enter a description for this reminder profile. | String |
Metadata
The following table shows the properties of metadata.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateMetadata. It indicates that the JSON file is used for metadata. | Enum | |
| Type | Enter the type of the metadata. | Enum | Valid values: SingleLineText MultiLineText YesOrNo Choices PeoplePickerValue Hyperlink AzureADProperty |
| DisplayType | This property value determines whether to display the metadata in reports. If you do not want to hide the metadata, define the reports where you want to display the metadata. | Enum | Valid values: Hide DisplayInAllPlaces (Display the metadata in Public Site Collection Directory, My Sites report, and My Teams and Groups report) OnlyDisplayInAdminReport (Display the metadata in Administration Reports) OnlyDisplayInEndUserReport (Display the metadata when business users view workspaces in the Cloud Governance Portal) |
| AssignBy | You assign the metadata value or allow business users to assign the metadata value. | Enum | Valid values: BusinessUser (Business users can assign the metadata value.) BusinessUserWithRequired (Business users are required to assign the metadata value.) ITAdminWithReadOnly (IT administrator assigns the metadata value and the metadata value is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the metadata value and the metadata value is not shown in the request form.) |
| BooleanMetadataSettings > EnableTerms | Set to true if you want to enable the desired terms and conditions. Note that if you enable terms and conditions agreement, only Yes can be the default value. | Boolean | |
| BooleanMetadataSettings > DefaultTermLanguage | Specify a default display language for the terms and conditions. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| BooleanMetadataSettings > Value | Set to true if you want the default value to be Yes. | Boolean | |
| BooleanMetadataSettings > TermsAndConditions > Language | Specify a language for the terms and conditions. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| BooleanMetadataSettings > TermsAndConditions > Term | Define the terms and conditions. | String | |
| BooleanMetadataSettings > TermsAndConditions > TrueValue | Enter your preferred value to replace Yes. | String | |
| BooleanMetadataSettings > TermsAndConditions > FalseValue | Enter your preferred value to replace No. | String | |
| BooleanMetadataSettings > TermsAndConditions > IsEnableCustomValue | Set to true if you change default terms and conditions metadata to your preferred values. | Boolean | |
| BooleanMetadataSettings > TermsAndConditions > IsEnabled | Set to true if you want to enable the language for the terms and conditions. | Boolean | |
| UserMetadataSettings > Users (Configure the settings for Person or Group metadata.) | Enter usernames or group names. | String collection | |
| UserMetadataSettings > AllowReferenceAsRoleInApprovalProcess (Configure the settings for Person or Group metadata.) | Set to true if you want to allow the metadata to be referenced as a variable role that can be assigned as an approver in an approval process. | Boolean | |
| UserMetadataSettings > PeoplePickerFilterProfile (Configure the settings for Person or Group metadata.) | Specify a people picker profile whose settings will be applied to the metadata value field in the end user request form. | ||
| AzureAdMetadataSettings > Tenant (Configure the settings for Microsoft Entra Property metadata.) | Enter a Microsoft 365 tenant name. | String | |
| AzureAdMetadataSettings > IsUseBuiltInProperty (Configure the settings for Microsoft Entra Property metadata.) | Set to true if you want to get value from Microsoft Entra built-in properties. | Boolean | |
| AzureAdMetadataSettings > Property (Configure the settings for Microsoft Entra Property metadata.) | Enter the name of a property whose value will be used as the metadata value. | String | |
| AzureAdMetadataSettings > TargetUser (Configure the settings for Microsoft Entra Property metadata.) | Enter usernames or certain user roles to specify users to get the user property value. | String | Valid user roles: $Requester $PrimarySiteCollectionContact $SecondarySiteCollectionContact $PrimaryGroupContact $SecondaryGroupContact |
| AzureAdMetadataSettings > AllowReferenceAsRoleInApprovalProcess (Configure the settings for Microsoft Entra Property metadata.) | Set to true if you want to allow the metadata to be reference as a variable role that can be assigned as an approver in an approval process. | Boolean | |
| ChoiceMetadataSettings > Choices (Configure the settings for Choice metadata.) | Enter the choices that you wish to provide. | String collection | |
| ChoiceMetadataSettings > Values (Configure the settings for Choice metadata.) | Enter a default value for the metadata. | String collection | |
| ChoiceMetadataSettings > ChoiceType (Configure the settings for Choice metadata.) | Enter the type of choices. | Enum | Valid values: DropDown RadioButton CheckBoxes |
| LinkMetadataSettings > Title (Configure the settings for Hyperlink metadata.) | Enter your desired text as the hyperlink title. | String | |
| LinkMetadataSettings > Address (Configure the settings for Hyperlink metadata.) | Enter the address of the hyperlink. | String | |
| SingleLineOrMultipleLineMetadataSettings > Value (Configure the settings for Single line of text or Multiple lines of text metadata.) | Enter a default value for the metadata. | String | |
| SingleLineOrMultipleLineMetadataSettings > EnableTextValidation (Configure the settings for Single line of text or Multiple lines of text metadata.) | Set to true if you want to apply validation rule to metadata values on the request page. | Boolean | |
| SingleLineOrMultipleLineMetadataSettings > TextValidationRuleName (Configure the settings for Single line of text or Multiple lines of text metadata.) | Enter a validation rule name. | String | |
| DuplicateAction | This property value determines how to deal with the metadata if there is an existing metadata with the same name. Use the new name with a suffix automatically added to the original metadata name, or do not create the metadata during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the metadata with the same name, the existing metadata with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Metadataname_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the metadata. | String | |
| Description | Enter a description for the metadata. | String | |
| Content > IsEnabled | Choose whether to enable display name and description in your desired languages. They are what your business users will see. | Boolean | |
| Content > DefaultLanguage | Specify a default language for the display name and description. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| Content > Contents > Name | Enter a display name for the metadata. | String | |
| Content > Contents > Language | Define the language for the display name and description. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| Content > Contents > Message | Enter a description for business users. | String | |
| Content > Contents > IsEnabled | Set to true if you want to enable the language for the display name and description. | Boolean |
Text Validation Rule
The following table shows the properties of a text validation rule.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateTextValidationRuleProfile. It indicates that the JSON file is used for the text validation rule. | Enum | |
| RegularExpression | Enter a regular expression for this rule. | String | |
| ErrorMessage | Define the message that will be displayed to the user once the entered content is invalid. | String | |
| ValidationText | Enter content that will be used to test the expected behavior of the entered regular expression. | String | |
| DuplicateAction | This property value determines how to deal with the rule if there is an existing rule with the same name. Use the new name with a suffix automatically added to the original rule name, or do not create the rule during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the rule with the same name, the existing rule with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Rulename_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the text validation rule | String | |
| Description | Enter a description for the text validation rule. | String |
Category
The following table shows the properties of the category.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateCategory. It indicates that the JSON file is used for the category management. | Enum | |
| EnglishDisplayName | Enter the category name in English. | String | |
| FrenchDisplayName | Enter the category name in French. | String | |
| JapaneseDisplayName | Enter the category name in Japanese. | String | |
| GermanDisplayName | Enter the category name in German. | String | |
| ItalianDisplayName | Enter the category name in Italian. | String | |
| DuplicateAction | This property value determines how to deal with the category if there is an existing category with the same name. Use the new name with a suffix automatically added to the original category name, or do not create the category during the import process. If the service has been successfully imported into Cloud Governance and you choose to not create the category with the same name, the existing category with the same name will be applied to the service. | Enum | Valid values: CreateNewWithSuffix (The format of the new name is Categoryname_1.) Skip (This JSON file will not be imported into Cloud Governance.) |
| Name | Enter a name for the category. | String | |
| Description | Enter a description for the category. | String |
On this page