Interface GovernanceRule
public interface GovernanceRule
An immutable client-side representation of GovernanceRule.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the GovernanceRule definition.static interface
The GovernanceRule definition stages.static interface
The template for GovernanceRule update.static interface
The GovernanceRule update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the conditionSets property: The governance rule conditionSets - see examples.Gets the description property: description of the governanceRule.Gets the displayName property: display name of the governanceRule.Gets the governanceEmailNotification property: The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners.id()
Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.security.fluent.models.GovernanceRuleInner object.Gets the isDisabled property: Defines whether the rule is active/inactive.Gets the isGracePeriod property: Defines whether there is a grace period on the governance rule.name()
Gets the name property: The name of the resource.Gets the ownerSource property: The Owner source for the governance rule - e.g.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.Gets the remediationTimeframe property: Governance rule remediation timeframe - this is the time that will affect on the grace-period duration e.g.void
Execute a security GovernanceRule on the given subscription.void
ruleIdExecuteSingleSubscription
(ExecuteGovernanceRuleParams executeGovernanceRuleParams) Execute a security GovernanceRule on the given subscription.void
ruleIdExecuteSingleSubscription
(ExecuteGovernanceRuleParams executeGovernanceRuleParams, com.azure.core.util.Context context) Execute a security GovernanceRule on the given subscription.int
Gets the rulePriority property: The governance rule priority, priority to the lower number.ruleType()
Gets the ruleType property: The rule type of the governance rule, defines the source of the rule e.g.Gets the sourceResourceType property: The governance rule source, what the rule affects, e.g.type()
Gets the type property: The type of the resource.update()
Begins update for the GovernanceRule resource.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
displayName
String displayName()Gets the displayName property: display name of the governanceRule.- Returns:
- the displayName value.
-
description
String description()Gets the description property: description of the governanceRule.- Returns:
- the description value.
-
remediationTimeframe
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.
-
isGracePeriod
Boolean isGracePeriod()Gets the isGracePeriod property: Defines whether there is a grace period on the governance rule.- Returns:
- the isGracePeriod value.
-
rulePriority
int rulePriority()Gets the rulePriority property: The governance rule priority, priority to the lower number. Rules with the same priority on the same subscription will not be allowed.- Returns:
- the rulePriority value.
-
isDisabled
Boolean isDisabled()Gets the isDisabled property: Defines whether the rule is active/inactive.- Returns:
- the isDisabled value.
-
ruleType
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
GovernanceRuleSourceResourceType sourceResourceType()Gets the sourceResourceType property: The governance rule source, what the rule affects, e.g. Assessments.- Returns:
- the sourceResourceType value.
-
conditionSets
Gets the conditionSets property: The governance rule conditionSets - see examples.- Returns:
- the conditionSets value.
-
ownerSource
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.
-
governanceEmailNotification
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.
-
innerModel
GovernanceRuleInner innerModel()Gets the inner com.azure.resourcemanager.security.fluent.models.GovernanceRuleInner object.- Returns:
- the inner object.
-
update
GovernanceRule.Update update()Begins update for the GovernanceRule resource.- Returns:
- the stage of resource update.
-
refresh
GovernanceRule refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
ruleIdExecuteSingleSubscription
Execute a security GovernanceRule on the given subscription.- Parameters:
executeGovernanceRuleParams
- GovernanceRule over a subscription scope.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
ruleIdExecuteSingleSubscription
void ruleIdExecuteSingleSubscription()Execute a security GovernanceRule on the given subscription.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
ruleIdExecuteSingleSubscription
void ruleIdExecuteSingleSubscription(ExecuteGovernanceRuleParams executeGovernanceRuleParams, com.azure.core.util.Context context) Execute a security GovernanceRule on the given subscription.- Parameters:
executeGovernanceRuleParams
- GovernanceRule over a subscription scope.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-