GovernanceRule Interface

Package:

com.azure.resourcemanager.security.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-security:1.0.0-beta.6

public interface GovernanceRule

An immutable client-side representation of GovernanceRule.

Method Summary

Modifier and Type	Method and Description
abstract List<Object>	conditionSets() Gets the conditionSets property: The governance rule conditionSets - see examples.
abstract String	description() Gets the description property: Description of the governance rule.
abstract String	displayName() Gets the displayName property: Display name of the governance rule.
abstract List<String>	excludedScopes() Gets the excludedScopes property: Excluded scopes, filter out the descendants of the scope (on management scopes).
abstract void	execute() Execute a governance rule.
abstract void	execute(ExecuteGovernanceRuleParams executeGovernanceRuleParams, Context context) Execute a governance rule.
abstract GovernanceRuleEmailNotification	governanceEmailNotification() Gets the governanceEmailNotification property: The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract Boolean	includeMemberScopes() Gets the includeMemberScopes property: Defines whether the rule is management scope rule (master connector as a single scope or management scope).
abstract GovernanceRuleInner	innerModel() Gets the inner com.azure.resourcemanager.security.fluent.models.GovernanceRuleInner object.
abstract Boolean	isDisabled() Gets the isDisabled property: Defines whether the rule is active/inactive.
abstract Boolean	isGracePeriod() Gets the isGracePeriod property: Defines whether there is a grace period on the governance rule.
abstract GovernanceRuleMetadata	metadata() Gets the metadata property: The governance rule metadata.
abstract String	name() Gets the name property: The name of the resource.
abstract GovernanceRuleOwnerSource	ownerSource() Gets the ownerSource property: The owner source for the governance rule - e.g.
abstract GovernanceRule	refresh() Refreshes the resource to sync with Azure.
abstract GovernanceRule	refresh(Context context) Refreshes the resource to sync with Azure.
abstract String	remediationTimeframe() Gets the remediationTimeframe property: Governance rule remediation timeframe - this is the time that will affect on the grace-period duration e.g.
abstract int	rulePriority() Gets the rulePriority property: The governance rule priority, priority to the lower number.
abstract GovernanceRuleType	ruleType() Gets the ruleType property: The rule type of the governance rule, defines the source of the rule e.g.
abstract GovernanceRuleSourceResourceType	sourceResourceType() Gets the sourceResourceType property: The governance rule source, what the rule affects, e.g.
abstract String	tenantId() Gets the tenantId property: The tenantId (GUID).
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the GovernanceRule resource.

Method Details

conditionSets

public abstract List

Gets the conditionSets property: The governance rule conditionSets - see examples.

Returns:

the conditionSets value.

description

public abstract String description()

Gets the description property: Description of the governance rule.

Returns:

the description value.

displayName

public abstract String displayName()

Gets the displayName property: Display name of the governance rule.

Returns:

the displayName value.

excludedScopes

public abstract List excludedScopes()

Gets the excludedScopes property: Excluded scopes, filter out the descendants of the scope (on management scopes).

Returns:

the excludedScopes value.

execute

public abstract void execute()

Execute a governance rule.

execute

public abstract void execute(ExecuteGovernanceRuleParams executeGovernanceRuleParams, Context context)

Execute a governance rule.

Parameters:

executeGovernanceRuleParams - Execute governance rule over a given scope.

context - The context to associate with this operation.

governanceEmailNotification

public abstract GovernanceRuleEmailNotification governanceEmailNotification()

Gets the governanceEmailNotification property: The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners.

Returns:

the governanceEmailNotification value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

includeMemberScopes

public abstract Boolean includeMemberScopes()

Gets the includeMemberScopes property: Defines whether the rule is management scope rule (master connector as a single scope or management scope).

Returns:

the includeMemberScopes value.

innerModel

public abstract GovernanceRuleInner innerModel()

Gets the inner com.azure.resourcemanager.security.fluent.models.GovernanceRuleInner object.

Returns:

the inner object.

isDisabled

public abstract Boolean isDisabled()

Gets the isDisabled property: Defines whether the rule is active/inactive.

Returns:

the isDisabled value.

isGracePeriod

public abstract Boolean isGracePeriod()

Gets the isGracePeriod property: Defines whether there is a grace period on the governance rule.

Returns:

the isGracePeriod value.

metadata

public abstract GovernanceRuleMetadata metadata()

Gets the metadata property: The governance rule metadata.

Returns:

the metadata value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

ownerSource

public abstract GovernanceRuleOwnerSource ownerSource()

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

Returns:

the ownerSource value.

refresh

public abstract GovernanceRule refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract GovernanceRule refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

remediationTimeframe

public abstract String remediationTimeframe()

Gets the remediationTimeframe property: 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.

Returns:

the remediationTimeframe value.

rulePriority

public abstract int rulePriority()

Gets the rulePriority property: The governance rule priority, priority to the lower number. Rules with the same priority on the same scope will not be allowed.

Returns:

the rulePriority value.

ruleType

public abstract GovernanceRuleType ruleType()

Gets the ruleType property: The rule type of the governance rule, defines the source of the rule e.g. Integrated.

Returns:

the ruleType value.

sourceResourceType

public abstract GovernanceRuleSourceResourceType sourceResourceType()

Gets the sourceResourceType property: The governance rule source, what the rule affects, e.g. Assessments.

Returns:

the sourceResourceType value.

tenantId

public abstract String tenantId()

Gets the tenantId property: The tenantId (GUID).

Returns:

the tenantId value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract GovernanceRule.Update update()

Begins update for the GovernanceRule resource.

Returns:

the stage of resource update.