RuleSet interface
Friendly RuleSet name mapping to the any RuleSet or secret related information.
- Extends
Properties
| batch |
Indicates whether rule set is in batch mode. When batch mode is enabled, rules will be processed in a batch along with the rule set. When batch mode is disabled, rules would need to be processed independently. This property can only be set during rule set creation and cannot be updated later. For switching modes, a new rule set needs to be created with the desired mode and rules need to be migrated to the new rule set. |
| deployment |
|
| profile |
The name of the profile which holds the rule set. |
| provisioning |
Provisioning status |
| rules | A list of rules that are part of this rule set provided the rule set is in batch mode. This property will be ignored if the rule set is not in batch mode. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
batchMode
Indicates whether rule set is in batch mode. When batch mode is enabled, rules will be processed in a batch along with the rule set. When batch mode is disabled, rules would need to be processed independently. This property can only be set during rule set creation and cannot be updated later. For switching modes, a new rule set needs to be created with the desired mode and rules need to be migrated to the new rule set.
batchMode?: boolean
Property Value
boolean
deploymentStatus
deploymentStatus?: string
Property Value
string
profileName
The name of the profile which holds the rule set.
profileName?: string
Property Value
string
provisioningState
Provisioning status
provisioningState?: string
Property Value
string
rules
A list of rules that are part of this rule set provided the rule set is in batch mode. This property will be ignored if the rule set is not in batch mode.
rules?: BatchRuleProperties[]
Property Value
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Property Value
string
Inherited From ProxyResource.id
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: string
Property Value
string
Inherited From ProxyResource.type