Share via

GovernanceRule interface

  • Reference
Package:
@azure/arm-security

Governance rule over a given scope

Extends
Resource

Properties

conditionSets

The governance rule conditionSets - see examples
description

Description of the governance rule
displayName

Display name of the governance rule
excludedScopes

Excluded scopes, filter out the descendants of the scope (on management scopes)
governanceEmailNotification

The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners
includeMemberScopes

Defines whether the rule is management scope rule (master connector as a single scope or management scope)
isDisabled

Defines whether the rule is active/inactive
isGracePeriod

Defines whether there is a grace period on the governance rule
metadata

The governance rule metadata
ownerSource

The owner source for the governance rule - e.g. Manually by user@contoso.com - see example
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
rulePriority

The governance rule priority, priority to the lower number. Rules with the same priority on the same scope will not be allowed
ruleType

The rule type of the governance rule, defines the source of the rule e.g. Integrated
sourceResourceType

The governance rule source, what the rule affects, e.g. Assessments
tenantId

The tenantId (GUID) NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

conditionSets

The governance rule conditionSets - see examples

conditionSets?: Record<string, unknown>[]

Property Value

Record<string, unknown>[]

description

Description of the governance rule

description?: string

Property Value

string

displayName

Display name of the governance rule

displayName?: string

Property 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?: GovernanceRuleEmailNotification

Property Value

GovernanceRuleEmailNotification

includeMemberScopes

Defines whether the rule is management scope rule (master connector as a single scope or management scope)

includeMemberScopes?: boolean

Property Value

boolean

isDisabled

Defines whether the rule is active/inactive

isDisabled?: boolean

Property Value

boolean

isGracePeriod

Defines whether there is a grace period on the governance rule

isGracePeriod?: boolean

Property Value

boolean

metadata

The governance rule metadata

metadata?: GovernanceRuleMetadata

Property Value

GovernanceRuleMetadata

ownerSource

The owner source for the governance rule - e.g. Manually by user@contoso.com - see example

ownerSource?: GovernanceRuleOwnerSource

Property Value

GovernanceRuleOwnerSource

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?: string

Property 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?: number

Property Value

number

ruleType

The rule type of the governance rule, defines the source of the rule e.g. Integrated

ruleType?: string

Property Value

string

sourceResourceType

The governance rule source, what the rule affects, e.g. Assessments

sourceResourceType?: string

Property Value

string

tenantId

The tenantId (GUID) NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type