Configure JSON Files for the Create Microsoft 365 Group Service
Refer to the following sections to configure the JSON files for a Create Microsoft 365 Group service and the associated policy, approval process, profiles, etc.
Create Microsoft 365 Group Service
The following table shows the properties of a Create Microsoft 365 service.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateGroupService. It indicates that the JSON file is used for the Create Microsoft 365 Group service. | Enum | |
| Tenant | Enter your Microsoft 365 tenant name. | String | |
| EnableHiddenOutlookExperience | Set to true if you want to hide the group from the Outlook client and Exchange global address list. | Boolean | |
| EnableWelcomeEmail | Set to true if you want to send a welcome e-mail to users when they are added to Microsoft 365 Groups. | Boolean | |
| Privacy | Configure the privacy settings for new Microsoft 365 Groups. | Enum | Valid values: Private Public |
| PrivacyAssignBy | You define the privacy settings for new Microsoft 365 Groups, or allow business users to configure the privacy when submitting requests via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to define the group privacy.) ITAdminWithReadOnly (IT administrator defines the group privacy or and the privacy is shown as read-only to business users.) ITAdminWithHide (IT administrator defines the privacy and the privacy is not shown in the request form.) |
| Subscribe | Configure whether to allow Microsoft 365 Group members to receive copies of group conversations and events. | Enum | Valid values: NotSend Send |
| SubscribeAssignBy | You define the subscribe setting or allow business users to configure this field in the request form. | Enum | Valid values: BusinessUserWithRequired (Business users are required to define the subscribe settings.) ITAdminWithReadOnly (IT administrator defines the subscribe settings and the subscribe settings are shown as read-only to business users.) ITAdminWithHide (IT administrator defines the subscribe settings and the subscribe settings are not shown in the request form.) |
| OutsideSender | Define whether you allow users outside the organization to send e-mails to Microsoft 365 Groups. | Enum | Valid values: Allow Forbid |
| OutsideSenderAssignBy | You define whether to allow users outside the organization to send e-mails to Microsoft 365 Groups, or allow business users to configure this field in the request form. | Enum | Valid values: BusinessUserWithRequired (Business users are required to configure the outside senders settings.) ITAdminWithReadOnly (IT administrator configures the outside senders settings and the outside senders settings are shown as read-only to business users.) ITAdminWithHide (IT administrator configures the outside senders settings and the outside senders settings are not shown in the request form.) |
| MembershipSettings > Owners | Enter one or more usernames or user taking certain roles to specify users to be the owners of the new Microsoft 365 Group. | String collection | Valid user roles: $Requester $ManagerOfRequester $PrimaryGroupContact $SecondaryGroupContact |
| MembershipSettings > OwnersAssignBy | You assign users to be group owners, or allow business users to assign group owners in the request form. | Enum | Valid values: BusinessUserWithRequired (Business users are required to assign the group owners.) ITAdminWithReadOnly (IT administrator assigns the group owners and the group owners are shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the group owners and the group owners are not shown in the request form.) |
| MembershipSettings > MembershipType | Specify a method to assign group members. | Enum | Valid values: Assigned (Manually select group members.) Dynamic (Business users define rules to get group members dynamically.) |
| MembershipSettings > Members | Enter usernames or certain user roles to assign users to be group members. | String collection | Valid user roles: $Requester $ManagerOfRequester $PrimaryGroupContact $SecondaryGroupContact |
| MembershipSettings > MembersAssignBy | You assign users to be group members, or allow business users to assign users in the request form. | Enum | Valid values: BusinessUserWithRequired (Business users are required to assign the group members.) ITAdminWithReadOnly (IT administrator assigns the group members and the group members are shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the group members and the group members are not shown in the request form.) |
| MembershipSettings > EnableHiddenGroupMembership | Set to true if you want to enable hidden membership to hide the group members from users who are not members of the group. | Boolean | |
| MembershipSettings > EnableHiddenGroupMembershipAssignBy | You define whether to enable the hidden membership, or allow business users to decide whether to enable the hidden membership in the request form. | Enum | Valid values: BusinessUserWithRequired (Business users are required to decide whether to enable the hidden membership.) ITAdminWithReadOnly (IT administrator decides whether to enable the hidden membership and the selection is shown as read-only to business users.) ITAdminWithHide (IT administrator decides whether to enable the hidden membership and the setting is not shown in the request form.) |
| MembershipSettings > DynamicMembershipRules > RuleName | Specify a dynamic membership rule name. | String | |
| MembershipSettings > DynamicMembershipRules > RuleValue | Specify the value for the rule. | String | |
| MembershipSettings > DynamicMembershipRules > DisableEditRuleValue | Set whether to allow requesters to define the rule value. | String | Valid values: True False |
| MembershipSettings > DynamicMembershipRules > Relation | Specify the relationship if you add multiple rule conditions to add group members. | String | Valid values: And (The group members will be added based on all the rule conditions.) Or (The group members will be added based on any of the rule conditions.) |
| MembershipSettings > DynamicMembershipRules > Category | Specify a category for the rule. | String | |
| MembershipSettings > DynamicMembershipRules > Condition | Specify the condition to define the rule value. | String | |
| MembershipSettings > DisableAddRemoveDynamicMembershipRules | Set whether to allow requesters to add or remove dynamic membership rules. | String | Valid values: True False |
| LinkSettings > EnablePlanner | Set to true if you want to display links of Planner that will be created together with Microsoft 365 Groups. | Boolean | |
| LinkSettings > EnableTeamSite | Set to true if you want to display links of Site that will be created together with Microsoft 365 Groups. | Boolean | |
| LinkSettings > EnableFiles | Set to true if you want to display links of Files (the Documents library) that will be created together with Microsoft 365 Groups. | Boolean | |
| LinkSettings > EnableConversations | Set to true if you want to display links of Conversations (group conversations in Outlook). | Boolean | |
| LinkSettings > EnableNotebook | Set to true if you want to display links of Notebook that will be created together with Microsoft 365 Groups. | Boolean | |
| GroupNameConstructSettings > Enabled | Set to true if you want to use prefix or suffix to construct the group name. | Boolean | |
| GroupNameConstructSettings - PrefixItems > Type | Specify the type for the prefix as a rule. | Enum | Valid values: Text Metadata Attribute |
| GroupNameConstructSettings - PrefixItems > Value | Enter the value for the specified rule. | String | |
| GroupNameConstructSettings - SuffixItems > Type | Specify the type for the suffix as a rule. | Enum | Valid values: Text Metadata Attribute |
| GroupNameConstructSettings - SuffixItems > Value | Enter the value for the specified rule. | String | |
| GroupNameConstructSettings - SuffixItems > ConstructRuleAssignBy | You define group names for Microsoft 365 groups, or allow business users to define group names based on the prefixes/suffixes in your rules. | Enum | Valid values: BusinessUser (Business users can define group names based on the prefixes/suffixes in your rule.) BusinessUserWithRequired (Business users are required to enter additional content for group names.) ITAdminWithReadOnly (IT administrator defines the prefixes/suffixes and the group name is shown as read-only to business users.) |
| GroupIdConstructSettings > EnableAutoSequenceNumber | Set to true if you want to automatically add a sequence number to the end of the group ID. | Boolean | |
| GroupIdConstructSettings > AutoSequenceNumber | Enter the sequence number rule in the format of {nn} or {nn*}. | String | |
| GroupIdConstructSettings > GroupIdRule | Choose to construct group ID, or automatically populate group ID with group name and hide group ID from business users. | Enum | Valid values: ConstructGroupId PopulateGroupIdWithGroupName |
| GroupIdConstructSettings > Enabled | Set to true if you want to construct the group ID rule. | Boolean | |
| GroupIdConstructSettings - PrefixItems > Type | Specify the type for the prefix as a rule. | Enum | Valid values: Text Metadata Attribute |
| GroupIdConstructSettings - PrefixItems > Value | Enter the value for the specified rule. | String | |
| GroupIdConstructSettings - SuffixItems > Type | Specify the type for the suffix as a rule. | Enum | Valid values: Text Metadata Attribute |
| GroupIdConstructSettings - SuffixItems > Value | Enter the value for the specified rule. | String | |
| GroupIdConstructSettings > ConstructRuleAssignBy | You define group names for Microsoft 365 groups, or allow business users to define group names based on the prefixes/suffixes in your rules. | Enum | Valid values: BusinessUser (Business users can define group IDs based on the prefixes/suffixes in your rule.) BusinessUserWithRequired (Business users are required to enter additional content for group IDs.) ITAdminWithReadOnly (IT administrator defines the prefixes/suffixes and the group ID is shown as read-only to business users.) |
| PreventDuplicateName | Set to true if you do not allow business users to request a new group using a name that is the same as the existing one. | Boolean | |
| EnableApp | Set to true if you want to automatically enable AvePoint Cloud Governance App. | Boolean | |
| EnableGroupSitePanel | Set to true if you want to automatically add the Cloud Governance Panel app part into the group team site. | 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 Italian Japanese |
| 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 options for the multiple added conditions. | Enum | Valid values: And Or |
| ConditionSettings > SourceType | Specify the metadata source type. | Enum | Valid values: ServiceMetadata GroupProperties |
| ConditionSettings > Condition | Specify the condition to define the metadata value. | Enum | Valid values: Equals Contains HasNoGuest HasExistingGuest HasNewGuest (The HasNoGuest, HasExistingGuest, HasNewGuest values are only available when you define NewlyMembers as the PropertyName.) |
| ConditionSettings > PropertyName | Specify a group property name. Note that you need to configure this field only when you define GroupProperties as the SourceType. | Enum | Valid values: None Privacy Calssification Owners Members NewlyMembers Language Subscribe Outside |
| 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-mail 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 | Specify conditions for users who can use the request. | Enum | Valid values: UserOrGroup AzureADProperty |
| ServicePermissionDetails > Value | Define values for the corresponding condition type. | String | |
| ServicePermissionDetails > Name | Enter usernames or group names. | String | |
| ServicePermissionDetails > Tenant | Enter your Microsoft 365 tenant name. | String | |
| ServicePermissionDetails > PropertyInputType | Specify the Microsoft Entra property type. | Enum | Valid values: Dropdown (It represents the built-in property.) Manual (It represents the custom property.) |
| Metadatas > Name | Enter the metadata name. | String | |
| Metadatas > AssignBy | You set the default value for the metadata or allow business users to assign the metadata value. | Enum | Valid values: BusinessUser (Business users can set the metadata value.) BusinessUserWithRequired (Business users are required to set the metadata value.) ITAdminWithReadOnly (IT administrator sets the default metadata value and the value is shown as read-only to business users.) ITAdminWithHide (IT administrator set the metadata value and the metadata 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 > 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 | |
| LanguageSettings > SelectedLanguages | Specify a language for the group. | String collection | Valid values: Afrikaans (Suid-Afrika) Azərbaycan dili (Azərbaycan) Bahasa Indonesia (Indonesia) Bahasa Melayu (Brunei Darussalam) Bahasa Melayu (Malaysia) bosanski (Bosna i Hercegovina) Català (Català) čeština (Česká republika) Cymraeg (Y Deyrnas Unedig) dansk (Danmark) Deutsch (Deutschland) Deutsch (Liechtenstein) Deutsch (Luxemburg) Deutsch (Österreich) Deutsch (Schweiz) eesti (Eesti) English (Australia) English (Belize) English (Canada) English (Caribbean) English (India) English (Ireland) English (Jamaica) English (Malaysia) English (New Zealand) English (Philippines) English (Singapore) English (South Africa) English (Trinidad and Tobago) English (United Kingdom) English (United States) English (Zimbabwe) español (Argentina) español (Bolivia) español (Chile) español (Colombia) español (Costa Rica) español (Ecuador) español (El Salvador) español (España, alfabetización internacional) español (Estados Unidos) español (Guatemala) español (Honduras) español (México) español (Nicaragua) español (Panamá) español (Paraguay) español (Perú) español (Puerto Rico) español (Republica Bolivariana de Venezuela) español (República Dominicana) español (Uruguay) euskara (euskara) Filipino (Pilipinas) français (Belgique) français (Canada) français (France) français (Luxembourg) français (Principauté de Monaco) français (Suisse) Gaeilge (Éire) Gàidhlig (An Rìoghachd Aonaichte) galego (galego) Hausa (Nijeriya) hrvatski (Bosna i Hercegovina) hrvatski (Hrvatska) íslenska (Ísland) italiano (Italia) italiano (Svizzera) Kiswahili (Kenya) latviešu (Latvija) Lëtzebuergesch (Lëtzebuerg) lietuvių (Lietuva) magyar (Magyarország) Malti (Malta) Nederlands (België) Nederlands (Nederland) norsk, bokmål (Norge) norsk, nynorsk (Noreg) O'zbekcha (O'zbekiston Respublikasi) polski (Polska) português (Angola) português (Brasil) português (Portugal) Reo Māori (Aotearoa) română (Republica Moldova) română (România) runa shimi (Ecuador Suyu) runasimi (Peru) runasimi (Qullasuyu) Shqip (Shqipëria) slovenčina (Slovenská republika) slovenščina (Slovenija) srpski (Srbija i Crna Gora (Bivša)) suomi (Suomi) svenska (Finland) svenska (Sverige) Tiếng Việt (Việt Nam) Türkçe (Türkiye) Türkmen dili (Türkmenistan) Valencià (Espanya) Ελληνικά (Ελλάδα) Беларуская (Беларусь) български (България) Кыргыз (Кыргызстан) Қазақ (Қазақстан) македонски јазик (Македонија) Монгол хэл (Монгол улс) русский (Россия) српски (Босна и Херцеговина) српски (Србија и Црна Гора (Бивша)) Татар (Россия) українська (Україна) Հայերեն (Հայաստան) ქართული (საქართველო) עברית (ישראל) اردو (بھارت) اُردو (پاکستان) العربية (الأردن) العربية (الإمارات العربية المتحدة) العربية (البحرين) العربية (الجزائر) العربية (العراق) العربية (الكويت) العربية (المملكة العربية السعودية) العربية (المملكة المغربية) العربية (اليمن) العربية (تونس) العربية (سوريا) العربية (عمان) العربية (قطر) العربية (لبنان) العربية (ليبيا) العربية (مصر) درى (افغانستان) سنڌي (پاکستان) فارسى (ایران) ئۇيغۇرچە (جۇڭخۇا خەلق جۇمھۇرىيىتى) कोंकणी (भारत) नेपाली (नेपाल) नेपाली (भारत) मराठी (भारत) हिंदी (भारत) অসমীয়া (ভাৰত) বাংলা (বাংলাদেশ) বাংলা (ভারত) ਪੰਜਾਬੀ (ਭਾਰਤ) ગુજરાતી (ભારત) ଓଡ଼ିଆ (ଭାରତ) தமிழ் (இந்தியா) తెలుగు (భారత దేశం) ಕನ್ನಡ (ಭಾರತ) മലയാളം (ഭാരതം) සිංහල (ශ්රී ලංකා) ไทย (ไทย) ພາສາລາວ (ສປປ ລາວ) ភាសាខ្មែរ (កម្ពុជា) አማርኛ (ኢትዮጵያ) 한국어(대한민국) 中文(中华人民共和国) 中文(台灣) 中文(新加坡) 中文(澳門特別行政區) 中文(香港特別行政區) 日本語 (日本) |
| LanguageSettings > DefaultLanguage | Specify a default language for the group. | String | |
| LanguageSettings > LanguageAssignBy | You assign the language for the group, or allow business users to select the language when submitting a request via this service. | Enum | Valid values: BusinessUserWithRequired (Business users are required to assign the language for the group.) ITAdminWithReadOnly (IT administrator assigns the language for the group and the language is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the language for the group and the language is not shown in the request form.) |
| ClassificationSettings > SelectedClassification | Specify classifications available for new groups created via this service. | String collection | |
| ClassificationSettings > DefaultClassification | Specify a default classification. | String | |
| ClassificationSettings > ClassificationAssignBy | You assign the classification to groups, or allow business users to specify the group classification when submitting a request via this service. | Enum | Valid values: BusinessUser (Business users can assign the group classification.) BusinessUserWithRequired (Business users are required to assign the group classification.) ITAdminWithReadOnly (IT administrator assigns the group classification and the classification is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the group classification and the classification is not shown in the request form.) |
| SensitivitySettings > SelectedSensitivity | Specify sensitivity labels that're available for new groups created via this service. | String collection | |
| SensitivitySettings > DefaultSensitivity | Specify a default sensitivity label. | String | |
| SensitivitySettings > SensitivityAssignBy | You assign the sensitivity label to groups, or allow business users to specify the group sensitivity label when submitting a request via this service. | Enum | Valid values: BusinessUser (Business users can assign the group sensitivity label.) BusinessUserWithRequired (Business users are required to assign the group sensitivity label.) ITAdminWithReadOnly (IT administrator assigns the group sensitivity label, and the sensitivity label is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the group 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 | |
| IsTimeZoneEnabled | Set to true if you want to define a standard time zone for the group team site. | Bool | |
| TimeZone | Define the time zone for the group team sites. | String | |
| TimeZoneAssignBy | You define the time zone to group team sites created by this service, or allow business users to select the time zone when submitting a service request for this service. | String | Valid values: BusinessUserWithRequired (Business users are required to define the time zone.) ITAdminWithReadOnly (IT administrator defines the time zone, and it is shown as read-only to business users.) ITAdminWithHide (IT administrator defines the time zone, and it is not shown in the request form.) |
| IsLocaleEnabled | Set to true if you want to define a locale to specify the way the group team site displays numbers, dates, and time. | Bool | |
| Locale | Define the time zone for the group team sites. | String | |
| LocaleAssignBy | You define the locale for group team sites created by this service, or allow business users to select the locale when submitting a service request for this service. | String | Valid values: BusinessUserWithRequired (Business users are required to define the locale.) ITAdminWithReadOnly (IT administrator defines the locale, and it is shown as read-only to business users.) ITAdminWithHide (IT administrator defines the locale, and it is not shown in the request form.) |
| PrimaryContact | Enter the name of a user to be the primary group contact. | String | |
| PrimaryContactAssignBy | You assign the primary 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 assign the primary contact.) ITAdminWithReadOnly (IT administrator assigns the primary contact, and the primary contact is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the primary contact and the primary contact is not shown in the request form.) |
| EnableNotifyPrimaryContact | Set to true if you want to notify the primary group contact when the group is successfully created. | Boolean | |
| PrimaryContactEmailTemplate | Enter the name of an e-mail template used to send the notification e-mail to the primary group contact. | String | |
| SecondaryContact | Enter the name of a user to be the secondary group contact. | String | |
| EnableNotifySecondaryContact | Set to true if you want to notify the secondary group contact when the group is successfully created. | Boolean | |
| SecondaryContactEmailTemplate | Enter the name of an e-mail template used to send the notification e-mail to the secondary group contact. | String | |
| SecondaryContactAssignBy | You assign the secondary group 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 assign the secondary contact.) ITAdminWithReadOnly (IT administrator assigns the secondary contact and the secondary contact is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the secondary contact and the secondary contact is not shown in the request form.) |
| HubSiteSettings > ConvertHubSiteType | Configure how to enable hub site functionality for the group team site. | Enum | Valid values: ConvertToHubSite AssociateOneHubSite |
| HubSiteSettings > EnableHubSite | Set to true if you want to enable the hub site functionality for the group team site. | Boolean | |
| HubSiteSettings > AssociateHubSite | Enter a hub name. | String | |
| HubSiteSettings > HubSiteAssignBy | You determine whether to enable the hub site functionality for the group team site, or allow business users to determine whether to enable hub site. | Enum | Valid values: BusinessUser (Business users can configure the hub site settings.) BusinessUserWithRequired (Business users are required to configure the hub site settings.) ITAdminWithReadOnly (IT administrator configures the hub site setting and the settings are shown as read-only to business users.) ITAdminWithHide (IT administrator configures the hub site settings and the settings are not shown in the request form.) |
| ModernTeamSiteDesign | Specify a default site template for the new group team site. 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: BusinessUser (Business users can assign the site template.) BusinessUserWithRequired (Business users are required to assign the site template.) ITAdminWithReadOnly (IT administrator assigns the site template and the template is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the site template and the template is not shown in the request form.) |
| SelectedPolicies | Enter the name of the group policies that can be applied to the groups created by this service. | String collection | |
| DefaultPolicy | Specify a default group policy that you wish to apply to the groups. Enter a group policy name. | String | |
| PolicyAssignBy | You assign the group policy to groups created via this service, or allow business users to assign the group policy. | Enum | Valid values: BusinessUserWithRequired (Business users are required to assign the group policy.) ITAdminWithReadOnly (IT administrator assigns the group policy and the policy is shown as read-only to business users.) ITAdminWithHide (IT administrator assigns the group policy and the policy is not shown in the request form.) |
| MultiGeoSettings > Enabled | Set to true if you want the new groups to be created in different geo-locations. | Boolean | |
| MultiGeoSettings > MultiGeoOption | You specify a geo location for the group created via this service, or assign the geo location according to the preferred data location (PDL) property of the requester or primary group 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 $PrimaryGroupContact |
| 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 |
Group Policy
The following table shows the properties of a group policy.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateGroupPolicy. It indicates that the JSON file is used for the group policy. | Enum | |
| Tenant | Enter your Microsoft 365 tenant name. | String | |
| StorageQuota | Enter a number to specify the Microsoft 365 Group team site quota. | Int32 | The unit is GB. |
| SharingSettings > EnableManageGroup | Set to true if you want to set unique guest access settings for the groups. | Boolean | |
| SharingSettings > EnableGroupInviteGuestUser | Set to true if you allow group owners to add people outside the organization to the group. | Boolean | |
| SharingSettings > AllowToInviteExternalUser | Set to true if you allow group owners to invite new external users who are not already in Microsoft Entra. | Boolean | |
| SharingSettings > EnableManageTeamSite | Set to true if you want to set unique external sharing settings for the site collection associated with the group. | Boolean | |
| SharingSettings > EnableTeamSiteInviteGuestUser | Set to true if you allow users to share the group team site content with people outside the organization. | Boolean | |
| SharingSettings > TeamSiteInviteType | Specify the scope of external users. | Enum | Valid values: Anyone NewAndExist Exist Disabled |
| SharingSettings > AllowMembersShare | Set to true if you allow users in the group to share the group team site and individual files and folders to other people. | Boolean | |
| SharingSettings > AllowMembersEditMembership | Set to true if you allow members to invite others to the site members group. | Boolean | |
| SharingSettings > AllowAccessRequests | Set to true if you allow users to request access to the group team site of the group applied with this policy. | Boolean | |
| SharingSettings > AccessRequestType | Specify who will receive access requests on the group team site. | Enum | Valid values: SpecifyEmail (Specific e-mail addresses) OwnerGroup (The site owners group) |
| SharingSettings > RequestAccessEmail | Enter the e-mail addresses of the approvers. | String | |
| SharingSettings > AccessRequestMessage | Define a custom message that can be shown to users who see the access request page. | String | |
| LifecycleSettings > DefaultApprovalProcess | Enter the name of an approval process that will be used as the default approval process. | String | |
| LifecycleSettings > DeletionSettings > EnableNotify | Set to true if you want to notify certain people when the group is deleted. | Boolean | |
| LifecycleSettings > DeletionSettings > NotifyUsers | Enter usernames or user roles to specify users that will be notified. | String collection | Valid user roles: $GroupOwners $PrimaryGroupContact $SecondaryGroupContact |
| LifecycleSettings > DeletionSettings > EmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | String | |
| LifecycleSettings > DeletionSettings > Enabled | Set to true if you want to allow business users to delete the group upon request. | Boolean | |
| LifecycleSettings > DeletionSettings > ApprovalProcess | Enter the name of an approval process if you want to use a unique approval process for the group deletion request. | String | |
| LifecycleSettings > DeletionSettings > IsUsedDefaultProcess | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings > ExtensionSettings > Type | Specify the method to set the limit on the group lease extension. | Enum | Valid values: Each (Each extension must be a specific period of time.) NoMore (Each extension cannot exceed a specific period of time.) |
| LifecycleSettings > ExtensionSettings > ConstantDuration | Enter a number for the amount of time to configure the extension. | Int32 | |
| LifecycleSettings > ExtensionSettings > ConstantDurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| LifecycleSettings > ExtensionSettings > MaxDuration | Enter a number for the amount of time to set limit to the extension period. | Int32 | |
| LifecycleSettings > ExtensionSettings > MaxDurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| LifecycleSettings > ExtensionSettings > Enabled | Set to true if you want to allow business users to extend the lease of a group. | Boolean | |
| LifecycleSettings > ExtensionSettings > ApprovalProcess | Enter the name of an approval process if you want to use a unique approval process for the group lease extension request. | String | |
| LifecycleSettings > ExtensionSettings > IsUsedDefaultProcess | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings > ChangePolicySettings > IsDefineChangeToPolicies | Set to true if you want to show list of available policies for selection to limit what policies are presented to users in the Group Lifecycle Management - Change Group Policy service. | Boolean | |
| LifecycleSettings > ChangePolicySettings > SelectedPolicies | Configure policies that are available to be selected. | String collection | |
| LifecycleSettings > ChangePolicySettings > Enabled | Set to true if you want to allow business users to change the group policy. | Boolean | |
| LifecycleSettings > ChangePolicySettings > ApprovalProcess | Enter the name of an approval process if you want to use a unique approval process for the group policy change request. | String | |
| LifecycleSettings > ChangePolicySettings > IsUsedDefaultProcess | Set to true if you want to use the default approval process. | Boolean | |
| LifecycleSettings > ChangeQuotaSettings > ChangeOption | Specify the quota change option to set limit for the quota change. | Enum | Valid values: AllowAnyValue (Allows business users to request to change site collection quota to any available size.) WithinSpecifyLimit (Allows business users to increase or decrease the group team site quota, and the change cannot exceed the size defined in the MaxValue property.) |
| LifecycleSettings > ChangeQuotaSettings > MaxValue | Specify the size to limit the site quota change. | Int32 | The unit is GB. |
| LifecycleSettings > ChangeQuotaSettings > Enabled | Set to true if you want to allow business users to change the group team site quota. | Boolean | |
| LifecycleSettings > ChangeQuotaSettings > ApprovalProcess | Enter the name of an approval process if you want to use a unique approval process for the group team site quota change request. | String | |
| LifecycleSettings > ChangeQuotaSettings > IsUsedDefaultProcess | Set to true if you want to use the default approval process. | Boolean | |
| InactivityThresholdSettings | Enabled | Set to true if you want to enable the group 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 |
| InactivityThresholdSettings | ApprovalProcess | Enter the name of an approval process. The approver configured in the approval process will be responsible for the group inactivity task. | String |
| InactivityThresholdSettings | EnableWarning | Set to true if you want to enable group inactivity threshold warning. | Boolean |
| InactivityThresholdSettings | WarningReminderProfile | Enter the name of a reminder profile. | String |
| InactivityThresholdSettings > AdditionalActionSettings > EnableAdditionalAction | Set to true if you want to enable an additional group lifecycle action. | Boolean | |
| InactivityThresholdSettings > AdditionalActionSettings > AdditionalActionType | Specify an additional group lifecycle action for escalation. | Enum | Valid values: None Delete Archive |
| InactivityThresholdSettings > AdditionalActionSettings > Duration | The additional group lifecycle actions will be started if the group inactivity threshold task is not completed after a specific period of time. Enter a number for the amount of time. | Int32 | |
| InactivityThresholdSettings > AdditionalActionSettings > DurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| InactivityThresholdSettings > AdditionalActionSettings > EnableRemind | Set to true if you want to enable a reminder for the approvers before the group deletion task is generated. | Boolean | |
| InactivityThresholdSettings > AdditionalActionSettings > ReminderProfile | Enter the name of a reminder profile. | String | |
| LeaseThresholdSettings | Enabled | Set to true if you want to enable the group lease management. | Boolean |
| LeaseThresholdSettings | Duration | Specify the amount of time for the lease period. | Int32 |
| LeaseThresholdSettings | DurationType | Specify the unit of time for the lease period. | Enum |
| LeaseThresholdSettings | ApprovalProcess | Enter the name of an approval process. The approver configured in the approval process will be responsible for the group lease expiration task. | String |
| LeaseThresholdSettings | EnableWarning | Set to true if you want to enable lease expiration warning. | Boolean |
| LeaseThresholdSettings | WarningReminderProfile | Enter the name of a reminder profile. | String |
| LeaseThresholdSettings > AdditionalActionSettings > EnableAdditionalAction | Set to true if you want to enable an additional group lifecycle action. | Boolean | |
| LeaseThresholdSettings > AdditionalActionSettings > AdditionalActionType | Specify an additional group lifecycle action for escalation. | Enum | Valid values: Delete Archive |
| LeaseThresholdSettings > AdditionalActionSettings > Duration | The additional group lifecycle action will be started if the group lease expiration task is not completed after a specific period of time. Enter a number for the amount of time. | Int32 | |
| LeaseThresholdSettings > AdditionalActionSettings > DurationType | Specify the unit of time for the duration. | Enum | Valid values: Day Week Month Year |
| LeaseThresholdSettings > AdditionalActionSettings > EnableRemind | Set to true if you want to enable a reminder for the approvers before a group deletion task is generated. | Boolean | |
| LeaseThresholdSettings > AdditionalActionSettings > ReminderProfile | Enter the name of a reminder profile. | String | |
| QuotaThresholdSettings > Enabled | Set to true if you want to enable the group team site quota threshold. | Boolean | |
| QuotaThresholdSettings > Percentage | Enter a number to set the quota threshold. | Int32 | |
| QuotaThresholdSettings > NotifyUsers | Specify users that will be notified when the group team site's storage reaches the specified percentage of the allocated quota. | String collection | |
| QuotaThresholdSettings > QuotaThresholdNotifyEmailTemplate | Enter the name of an e-mail template that will be used to send the notification e-mail. | 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 group contacts is deactivated. | Boolean | |
| DeactiveContactElectionSettings > EnableNotifyUsers | Set to true if you want to notify specified people when both the primary and secondary contact are deactivated. | Boolean | |
| DeactiveContactElectionSettings > ElectionNotifyUsers | Enter usernames, groups' e-mail addresses, or enter $ to specify a user role who will receive a copy of the notification e-mail. | String collection | Valid user role: $GroupMembers |
| 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 group 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 group 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 | |
| EnableRenewal | Set to true if you want to enable the renewal process for the group applied with the policy. | Boolean | |
| RenewalProfile | Enter the name of a renewal profile. | String | |
| Category | Enter the name of a category that is used to organize the group 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 this group policy. | String | |
| Description | Enter a description for this group 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 or group names or user roles to specify additional users and/or groups that you want to be notified when the service request is completed without assigning tasks to them. | String collection | Valid user roles: $ManagerOfApprover $AdministratorContact $ManagerOfRequester $GroupOwners $PrimaryGroupContact $SecondaryGroupContact |
| 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 $GroupMetadata(" {Metadata Name}")$GroupOwners $PrimaryGroupContact $SecondaryGroupContact $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 | Set to true if you want to enable duration for the approval process. | Boolean | |
| StageOneSettings > DurationSetting > Reassignee | Enter a usernames or user role to specify the user that the task will be re-assigned to. | String | Valid user role: $ManagerOfApprover |
| StageOneSettings > DurationSetting > EscalationUsers | Enter usernames or a user role to specify users that will be notified. | String collection | Valid user role: $ManagerOfApprover |
| StageOneSettings > DurationSetting > EnableDurationReminder | Set to true if you want to enable reminder before the escalation. | Boolean | |
| StageOneSettings > DurationSetting > Duration | Enter a number to specify the amount of time for the duration. | Int32 | |
| StageOneSettings > DurationSetting > ReassignEmailTemplate | 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 | 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 | 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 | Enter the name of a reminder profile. | String | |
| StageOneSettings > DurationSetting > DurationType | Enter a duration type. | Enum | Valid values: Day Week |
| StageOneSettings > DurationSetting > EscalationType | Specify an escalation type. | Enum | Valid values: Notify ReAssignTo AutoReject |
| StageOneSettings > EmailSetting > EnableNotifyApproverWhenAssigned | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageOneSettings > EmailSetting > NotifyApproverEmailTemplate | 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 | Set to true if you want to notify the requester when the request is approved. | Boolean | |
| StageOneSettings > EmailSetting > NotifyRequesterApprovedEmailTemplate | 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 | Set to true if you want to notify the requester when the request is rejected. | Boolean | |
| StageOneSettings > EmailSetting > NotifyRequesterRejectedEmailTemplate | 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 | Set to true if you want to notify the approver and requester when the request is canceled. | Boolean | |
| StageOneSettings > EmailSetting > NotifyApproverCancelledEmailTemplate | 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 | Set to true if you want to notify all previous approvers when the request is rejected. | Boolean | |
| StageOneSettings > EmailSetting > NotifyApproverRejectedEmailTemplate | 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 $ManagerOfPreviousStageApprover $GroupOwners $PrimaryGroupContact $SecondaryGroupContact $GroupMetadata(" {Metadata Name}")$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 | Set to true if you want to enable duration for the approval process. | Boolean | |
| StageTwoSettings > DurationSetting > Reassignee | Enter a username or user role to specify the user that the task will be re-assigned to. | String | Valid user role: $ManagerOfApprover |
| StageTwoSettings > DurationSetting > EscalationUsers | Enter usernames or a user role to specify users that will be notified. | String collection | Valid user role: $ManagerOfApprover |
| StageTwoSettings > DurationSetting > EnableDurationReminder | Set to true if you want to enable reminder before the escalation. | Boolean | |
| StageTwoSettings > DurationSetting > Duration | Enter a number to specify the amount of time for the duration. | Int32 | |
| StageTwoSettings > DurationSetting > ReassignEmailTemplate | 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 | 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 | 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 | Enter the name of a reminder profile. | String | |
| StageTwoSettings > DurationSetting > DurationType | Enter a duration type. | Enum | Valid values: Day Week |
| StageTwoSettings > DurationSetting > EscalationType | Specify an escalation type. | Enum | Valid values: Notify ReAssignTo AutoReject |
| StageTwoSettings > EmailSetting > EnableNotifyApproverWhenAssigned | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageTwoSettings > EmailSetting > NotifyApproverEmailTemplate | 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 | Set to true if you want to notify the requester when the request is approved. | Boolean | |
| StageTwoSettings > EmailSetting > NotifyRequesterApprovedEmailTemplate | 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 | Set to true if you want to notify the requester when the request is rejected. | Boolean | |
| StageTwoSettings > EmailSetting > NotifyRequesterRejectedEmailTemplate | 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 | Set to true if you want to notify the approver and requester when the request is canceled. | Boolean | |
| StageTwoSettings > EmailSetting > NotifyApproverCancelledEmailTemplate | 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 | Set to true if you want to notify all previous approvers when the request is rejected. | Boolean | |
| StageTwoSettings > EmailSetting > NotifyApproverRejectedEmailTemplate | Enter the name of an e-mail template that will be used to notify all previous approvers when the request is rejected. | String | |
| 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 $ManagerOfPreviousStageApprover $GroupOwners $PrimaryGroupContact $SecondaryGroupContact $GroupMetadata(" {Metadata Name}")$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 | Set to true if you want to enable duration for the approval process. | Boolean | |
| StageThreeSettings > DurationSetting > Reassignee | Enter a username or user role to specify the user that the task will be re-assigned to. | String | Valid user role: $ManagerOfApprover |
| StageThreeSettings > DurationSetting > EscalationUsers | Enter usernames or a user role to specify users that will be notified. | String collection | Valid user role: $ManagerOfApprover |
| StageThreeSettings > DurationSetting > EnableDurationReminder | Set to true if you want to enable reminder before the escalation. | Boolean | |
| StageThreeSettings > DurationSetting > Duration | Enter a number to specify the amount of time for the duration. | Int32 | |
| StageThreeSettings > DurationSetting > ReassignEmailTemplate | 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 | 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 | 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 | Enter the name of a reminder profile. | String | |
| StageThreeSettings > DurationSetting > DurationType | Enter a duration type. | Enum | Valid values: Day Week |
| StageThreeSettings > DurationSetting > EscalationType | Specify an escalation type. | Enum | Valid values: Notify ReAssignTo AutoReject |
| StageThreeSettings > EmailSetting > EnableNotifyApproverWhenAssigned | Set to true if you want to notify the approver when the task is assigned. | Boolean | |
| StageThreeSettings > EmailSetting > NotifyApproverEmailTemplate | 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 | Set to true if you want to notify the requester when the request is approved. | Boolean | |
| StageThreeSettings > EmailSetting > NotifyRequesterApprovedEmailTemplate | 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 | Set to true if you want to notify the requester when the request is rejected. | Boolean | |
| StageThreeSettings > EmailSetting > NotifyRequesterRejectedEmailTemplate | 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 | Set to true if you want to notify the approver and requester when the request is canceled. | Boolean | |
| StageThreeSettings > EmailSetting > NotifyApproverCancelledEmailTemplate | 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 | Set to true if you want to notify all previous approvers when the request is rejected. | Boolean | |
| StageThreeSettings > EmailSetting > NotifyApproverRejectedEmailTemplate | 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 > EnableAutoApproveWhenRequesterIn AutoApproveGroup | 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 | Enter the name of an e-mail template that will be used to send the request completion notification e-mail. | String | |
| 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 | Enter a name for this approval process. | String | |
| Description | Enter a description for this approval process. | String |
Group Renewal Profile
The following table shows the properties of a group renewal profile.
| Property | Description | Type | Notes |
|---|---|---|---|
| TemplateType | This property value is CreateGroupRenewalProfile. It indicates that the JSON file is used for the group renewal profile. | Enum | |
| EnableMembershipRenewal | Set to true if you want to enable the membership renewal. | Boolean | |
| EnableOwnersRenewal | Set to true if you allow renewal task assignees to review and modify group owners. | Boolean | |
| EnableMembersRenewal | Set to true if you allow renewal task assignees to review and modify group members. | Boolean | |
| EnableAddOwners | Set to true if you want to allow renewal task assignees to add owners to the group during the renewal process. | Boolean | |
| EnableAddMembers | Set to true if you allow renewal task assignees to add members to the group during the renewal process. | Boolean | |
| EnableMembershipOnlyExternalUsers | Set to true if you allow renewal task assignees to only renew external users during the membership renewal process. | Boolean | |
| EnableAtLeastOwners | Set to true if you want to limit the minimum amount of required group owners. | Boolean | |
| EnableRemoveBlockedOwners | Set to true if you want to enable the recommended action for renewal task assignees to remove users who have been blocked from signing in Microsoft Entra. | Boolean | |
| EnableRemoveAdditionalPermission | Set to true if you want to enable the recommended action for renewal task assignees to remove all user permissions except owners and members. | Boolean | |
| EnableOnlyExternalUsers | Set to true if you allow renewal task assignees to only renew external users. | Boolean | |
| EnableSharingLinksRenewal | Set to true if you allow renewal task assignees to renew sharing links. | Boolean | |
| EnableAddUsersToSPGroup | Set to true if you allow renewal task assignees to add users to SharePoint groups during the renewal process. | 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 sharing links with external user access. | Boolean | |
| OwnersCount | Enter a number to specify the minimum amount of required group owners. | Int | |
| 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 as the renewal task assignee. | String collection | Valid user roles: $PrimaryGroupContact $SecondaryGroupContact $GroupOwners $ManagerOfPrimaryGroupContact $ManagerOfSecondaryGroupContact |
| 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 month 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 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 > 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 | This property is for team renewal. Set to false when you configure a group renewal profile. | Boolean | |
| EnableDeletion | Set to true if you allow the renewal task assignee to delete the group. | Boolean | |
| EnableContactRenewal | Set to true if you allow renewal task assignees to review and modify primary group contact and secondary group 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 group metadata. | Boolean | |
| EnablePermissionRenewal | Set to true if you allow renewal task assignees to review and modify user and SharePoint group permissions to the corresponding group team site. | Boolean | |
| RenewalChannelSetting > IsEnabled | Set to true if you allow renewal task assignees to review and modify group related team's private channels. | Boolean | |
| RenewalChannelSetting > Assignee | Enter user roles to assign users as private channel task assignees. | String | Valid user roles: $TeamsOwners $TeamsContacts $ChannelOwners |
| RenewalChannelSetting > NotifyAssigneeEmailTemplate | Enter the name of an e-mail template that will be used to notify the assignee of the renewal task. | String | |
| RenewalChannelSetting > EnableOwnersRenewal | Set to true if you allow renewal task assignees to review and modify private channel owners. | Boolean | |
| RenewalChannelSetting > EnableMembersRenewal | Set to true if you allow renewal task assignees to review and modify private channel members. | Boolean | |
| RenewalChannelSetting > AllowAssigneeDeleteChannel | Set to true if you allow private channel renewal task assignees to delete the private channel. | Boolean | |
| RenewalChannelSetting > AllowTeamAssigneeDeleteChannel | Set to true if you allow the team renewal task assignee to delete the private channel. | Boolean | |
| RenewalChannelSetting > EnableTaskOverdueRemind | Set to true if you want to send a reminder email to the renewal task assignees before the renewal process is overdue. | Boolean | |
| RenewalChannelSetting > TaskOverdueReminderProfile | Enter the name of an e-mail template that will be used to send the overdue renewal process reminder email. | String | |
| RenewalChannelSetting > DefaultLanguage | Specify a default language for the custom message shown to the private channel renewal process assignee. Note that only the language whose property isEnabled is set to true and can be set as the default language. | Enum | |
| RenewalChannelSetting > CustomizedMessageList > CustomizedMessageValue | Enter a message that will be displayed to the renewal task assignee. | String | |
| RenewalChannelSetting > CustomizedMessageList > isEnabled | Set to true if you want to enable the language for the custom message. | Boolean | |
| RenewalChannelSetting > CustomizedMessageList > Language | Define the language for the custom message shown to the private channel renewal process assignee. | Enum | Valid values: English, French, Japanese, Portuguese, German, Italian, Chinese, Spanish |
| 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 group renewal profile. | String | |
| Description | Enter the description of the group renewal 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 | Enter usernames or group names. | String collection | |
| UserMetadataSettings > AllowReferenceAsRoleInApprovalProcess | 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 | Specify a people picker profile whose settings will be applied to the metadata value field in the end user request form. | ||
| AzureAdMetadataSettings > Tenant | Enter a Microsoft 365 tenant name. | String | |
| AzureAdMetadataSettings > IsUseBuiltInProperty | Set to true if you want to get value from Microsoft Entra built-in properties. | Boolean | |
| AzureAdMetadataSettings > Property | Enter the name of a property whose value will be used as the metadata value. | String | |
| AzureAdMetadataSettings > TargetUser | 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 | 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 | Enter the choices that you wish to provide. | String collection | |
| ChoiceMetadataSettings > Values | Enter a default value for the metadata. | String collection | |
| ChoiceMetadataSettings > ChoiceType | Enter the type of choices. | Enum | Valid values: DropDown RadioButton CheckBoxes |
| LinkMetadataSettings > Title | Enter your desired text as the hyperlink title. | String | |
| LinkMetadataSettings > Address | Enter the address of the hyperlink. | String | |
| SingleLineOrMultipleLineMetadataSettings > Value | Enter a default value for the metadata. | String | |
| SingleLineOrMultipleLineMetadataSettings > EnableTextValidation | Set to true if you want to apply validation rule to metadata values on the request page. | Boolean | |
| SingleLineOrMultipleLineMetadataSettings > TextValidationRuleName | 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 a 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