audit
Creates, updates, deletes, gets or lists an audit resource.
Overview
| Name | audit |
| Type | Resource |
| Id | sumologic.policies.audit |
Fields
The following fields are returned by SELECT queries:
- getAuditPolicy
The Audit policy.
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | Whether the Audit policy is enabled. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
getAuditPolicy | select | region | Get the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. Learn More | |
setAuditPolicy | exec | region, enabled | Set the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. Learn More |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
SELECT examples
- getAuditPolicy
Get the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. Learn More
SELECT
enabled
FROM sumologic.policies.audit
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- setAuditPolicy
Set the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. Learn More
EXEC sumologic.policies.audit.setAuditPolicy
@region='{{ region }}' --required
@@json=
'{
"enabled": {{ enabled }}
}'
;