GovernanceRuleProperties interface
Describes properties of an governance rule
Properties
| condition |
The governance rule conditionSets - see examples |
| description | Description of the governance rule |
| display |
Display name of the governance rule |
| excluded |
Excluded scopes, filter out the descendants of the scope (on management scopes) |
| governance |
The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners |
| include |
Defines whether the rule is management scope rule (master connector as a single scope or management scope) |
| is |
Defines whether the rule is active/inactive |
| is |
Defines whether there is a grace period on the governance rule |
| metadata | The governance rule metadata |
| owner |
The owner source for the governance rule - e.g. Manually by user@contoso.com - see example |
| remediation |
Governance rule remediation timeframe - this is the time that will affect on the grace-period duration e.g. 7.00:00:00 - means 7 days |
| rule |
The governance rule priority, priority to the lower number. Rules with the same priority on the same scope will not be allowed |
| rule |
The rule type of the governance rule, defines the source of the rule e.g. Integrated |
| source |
The governance rule source, what the rule affects, e.g. Assessments |
| tenant |
The tenantId (GUID) |
Property Details
conditionSets
The governance rule conditionSets - see examples
conditionSets: any[]Property Value
any[]
description
Description of the governance rule
description?: stringProperty Value
string
displayName
Display name of the governance rule
displayName: stringProperty Value
string
excludedScopes
Excluded scopes, filter out the descendants of the scope (on management scopes)
excludedScopes?: string[]Property Value
string[]
governanceEmailNotification
The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners
governanceEmailNotification?: GovernanceRuleEmailNotificationProperty Value
includeMemberScopes
Defines whether the rule is management scope rule (master connector as a single scope or management scope)
includeMemberScopes?: booleanProperty Value
boolean
isDisabled
Defines whether the rule is active/inactive
isDisabled?: booleanProperty Value
boolean
isGracePeriod
Defines whether there is a grace period on the governance rule
isGracePeriod?: booleanProperty Value
boolean
metadata
The governance rule metadata
metadata?: GovernanceRuleMetadataProperty Value
ownerSource
The owner source for the governance rule - e.g. Manually by user@contoso.com - see example
ownerSource: GovernanceRuleOwnerSourceProperty Value
remediationTimeframe
Governance rule remediation timeframe - this is the time that will affect on the grace-period duration e.g. 7.00:00:00 - means 7 days
remediationTimeframe?: stringProperty Value
string
rulePriority
The governance rule priority, priority to the lower number. Rules with the same priority on the same scope will not be allowed
rulePriority: numberProperty Value
number
ruleType
The rule type of the governance rule, defines the source of the rule e.g. Integrated
ruleType: stringProperty Value
string
sourceResourceType
The governance rule source, what the rule affects, e.g. Assessments
sourceResourceType: stringProperty Value
string
tenantId
The tenantId (GUID)
tenantId?: stringProperty Value
string
