search_audit
Creates, updates, deletes, gets or lists a search_audit resource.
Overview
| Name | search_audit |
| Type | Resource |
| Id | sumologic.policies.search_audit |
Fields
The following fields are returned by SELECT queries:
- getSearchAuditPolicy
The Search Audit policy.
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | Whether the Search Audit policy is enabled. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
getSearchAuditPolicy | select | region | Get the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. Learn More | |
setSearchAuditPolicy | exec | region, enabled | Set the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search 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
- getSearchAuditPolicy
Get the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. Learn More
SELECT
enabled
FROM sumologic.policies.search_audit
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- setSearchAuditPolicy
Set the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. Learn More
EXEC sumologic.policies.search_audit.setSearchAuditPolicy
@region='{{ region }}' --required
@@json=
'{
"enabled": {{ enabled }}
}'
;